/rally-api

Primary LanguagePython

Rally API

Requirements

  • python 3.10.x

Development

  • Create a virtual environment
  • Activate the virtual environment
  • Install dependencies
  • Run the application

Create virtual environment

python -m venv venv

Activate virtual environment

mac / linux os

source venv/bin/activate

windows os

venv\Scripts\activate

Install dependencies

python -m pip install -r requirements.txt

Run the application

python -m uvicorn app.main:app --host 0.0.0.0 --port 3000 --reload

optional: use Docker to run this project

docker-compose up

Example .env file

SECRET_KEY = "YourSecretKey"
ALGORITHM = "HS256"
ACCESS_TOKEN_EXPIRE_MINUTES = 30
ORIGINS = "http://localhost,http://localhost:3000,http://localhost:3000/*"

Semantic Commit Messages

feat: (new feature for the user, not a new feature for build script)
fix: (bug fix for the user, not a fix to a build script)
docs: (changes to the documentation)
style: (formatting, missing semi colons, etc; no production code change)
refactor: (refactoring production code, eg. renaming a variable)
test: (adding missing tests, refactoring tests; no production code change)
chore: (updating grunt tasks etc; no production code change)