Skip to content

Latest commit

 

History

History
119 lines (87 loc) · 3.72 KB

README.md

File metadata and controls

119 lines (87 loc) · 3.72 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Saturday Hacknight

Where Hacking Happens

Table of Contents
  1. About The Project
  2. Getting Started

About The Project

Saturday Hacknight is a community built Platform for Tinkers to conduct Hacking activities.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

You need to install

  1. Node v16
  2. Yarn

Installation

  1. Clone the repo

    git clone https://github.com/tinkerhub/saturday-hack-night.git

  2. Install all the NPM packages all the applications.

    We are using Yarn workspace and turborepo to manage the applications in monorepo.

    yarn install

  3. Copy the .env.example for each applications to .env in the same directory and fill the values required

  4. Start the web application dev server and open http://localhost:3000

    yarn workspace web dev

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)