Skip to content

Latest commit

 

History

History
115 lines (69 loc) · 4.95 KB

README.md

File metadata and controls

115 lines (69 loc) · 4.95 KB
Raw

Team MentorMe - MentorMe API

Project Overview

Team MentorMe - MentorMe API

Live link is at https://mentorme-be.vercel.app

Redoc docs at https://mentorme-be.vercel.app/redoc/

Markdown docs at DOCUMENTATION.md

Installation Instructions

Prerequisites

Before setting up the project locally, ensure you have the following prerequisites installed:

Installation Steps

  1. Clone the repository:

     git clone https://github.com/hngx-org/mentorme-be.git

  2. Change into the parent directory:

     cd mentorme-be.git

  3. Set up a virtual environment:

     python3 -m venv venv

  4. Activate your virtual environment:

     source venv/bin/activate

  5. Install the Python dependencies:

     pip install -r requirements.txt

  6. Create a .env file and set necessary secret keys below:

  7. Apply migrations to create the database schema:

     python3 manage.py migrate

  8. Start the development server:

python3 manage.py runserver

The API should now be running locally at http://localhost:8000/.

Commit Standards

Branches

  • dev -> pr this branch for everything backend related
  • main -> dont touch this branch, this is what is running in production.

Contributions

Team_MentorMe is open to contributions, but we recommend creating an issue or replying in a comment to let us know what you are working on first that way we don't overwrite each other.

Contribution Guidelines

  1. Clone the repo git clone https://github.com/hngx-org/mentorme-be.git.
  2. Open your terminal & set the origin branch: git remote add origin https://github.com/hngx-org/mentorme-be.git
  3. Pull origin git pull origin development
  4. Create a new branch for the task you were assigned to, eg TicketNumber/(Feat/Bug/Fix/Chore)/Ticket-title : git checkout -b ZA-001/Feat/Sign-Up-from
  5. After making changes, do git add .
  6. Commit your changes with a descriptive commit message : git commit -m "your commit message".
  7. To make sure there are no conflicts, run git pull origin dev.
  8. Push changes to your new branch, run git push -u origin feat-csv-parser.
  9. Create a pull request to the dev branch not main.
  10. Ensure to describe your pull request.

  11. If you've added code that should be tested, add some test examples.

Merging

Under any circumstances should you merge a pull request on a specific branch to the dev or main branch

Commit CheatSheet

Type Description
feat Features A new feature
fix Bug Fixes A bug fix
docs Documentation Documentation only changes
style Styles Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
refactor Code Refactoring A code change that neither fixes a bug nor adds a feature
perf Performance Improvements A code change that improves performance
test Tests Adding missing tests or correcting existing tests
build Builds Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci Continuous Integrations Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
chore Chores Other changes that don't modify, backend or test files
revert Reverts Reverts a previous commit

Sample Commit Messages

  • chore: Updated README file:= chore is used because the commit didn't make any changes to the frontend or test folders in any way.
  • feat: Added plugin info endpoints:= feat is used here because the feature was non-existent before the commit.