Skip to content

LUMS-SE-Project/InGate-Backend

Repository files navigation

Welcome to the project directory

To run the server, you need to type

uvicorn app.index:app --reload

To add new routes, you need to add a new file in the app/api/v1 folder and add the route in the index.py file

To add new models, you need to add a new file in the app/core folder and add the model in the index.py file

To add new tests, you need to add a new file in the tests folder and add the test in the index.py file

To add new dependencies, you need to add a new file in the requirements folder and add the dependency in the index.py file

To add new utils, you need to add a new file in the utils folder and add the util in the index.py file

To create a .env file, you need to create a .env file in the root directory and add the following variables

- MONGO_URL

Please contact Jazlan for the MONGO_URL. You will not be able to connect to the DB without the URL.

Models interacts with the DB -> Queries Schema is what you get out of the DB -> Data extracted from DB -> List of Schemas (List of Dicts) Routes is where you define end points, APIs, etc Utils is where you define functions that you can use in multiple places -> helper functions

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •