a-bmt02 / tweet-guard-backend Goto Github PK

View Demo · Report Bug · Request Feature

To get a local copy up and running follow these simple steps.

Before installation, please make sure you have already installed the following tools:

• Git
• NodeJs

1. Fork the project. Click on the fork icon in the top right to get started

2. Clone the project, you can use the following command:

   git clone https://github.com/<your-github-username>/Tweet-Guard-Backend

3. Navigate to the project directory

   cd tweet-guard-backend

4. Install dependencies with npm install

   npm install

5. Install Package for conventional Commits

   npm install -g commitizen 

(back to top)

• Contributions make the open source community such an amazing place to learn, inspire, and create.
• Any contributions you make are greatly appreciated.
• Check out our contribution guidelines for more information.

(back to top)

1. Create a new branch

git checkout -b YourBranchName

2. Add it to staging area

NOTE: don't commit the package.json unless you are installing a new package

git add .

3. Commit your changes with

git cz

4. Push your changes

git push

Don't forget to join the discord community - Join us

TweetGuard is licensed under the MIT License - see the LICENSE file for details.

(back to top)

Thanks a lot for spending your time helping TweetGuard grow. Thanks a lot! Keep rocking🍻

(back to top)

This project needs a star️ from you. Don't forget to leave a star🌟

(back to top)