Skip to content

Latest commit

 

History

History
131 lines (81 loc) · 2.05 KB

README.md

File metadata and controls

131 lines (81 loc) · 2.05 KB

Raunak'23

Table of Contents

Installation

Setup

  1. Clone the repository:
git clone https://github.com/IEEE-MSIT-Project-Committee-23/Raunak.git
  1. Navigate to the project directory:
cd Raunak
  1. Branch:
git checkout -b <branch_name>

Frontend

  1. Navigate to the frontend directory:
cd client
  1. Install Dependencies:
npm install
  1. Start the app:
npm run dev

Server

  1. Navigate to the frontend directory:
cd server
  1. Install Dependencies:
npm install
  1. Create environment file:
cp sample.env .env
  1. Start the app:
npm run dev

Contributing

It is recommended to keep your changes grouped logically within individual commits.

  1. Add the current files:
git add <changed_files>
  1. Commit the changes :

Before Committing the changes check Commit Message Guidelines

git commit -m "<message>"
  1. Push the changes to remote:
git push origin <branch_name>
  1. Create a Pull Request

Commit_Message_Guidelines

A good commit message should describe what changed and why.

Before a pull request can be merged, it must have a pull request title with a semantic prefix.

Examples of commit messages with semantic prefixes:

  • fix: A bug fix
  • feat: A new feature
  • docs: Documentation changes
  • test: Adding missing tests or correcting existing tests
  • build: Changes that affect the build system
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (linting)

This commit message convention helps maintain a clear and structured history for your project, making it easier to understand and manage changes.