Pipeline API

Project Setup

1. Navigate to where you want to clone the repo in your terminal

2. Clone Repo on to Local Machine

   # HTTPS
   git clone https://github.com/Repped-In-Tech/pipeline-be.git

   # SSH
   git clone [email protected]:Repped-In-Tech/pipeline-be.git

3. Open Cloned Project

   cd pipeline-be; code .;

4. Create Virtual Envirunment

   pipenv shell

5. Select interpreter within vscode

   • Open your Command Palette
   • Search for "Python: Select Interpreter"
   • Find the interpreter that includes pipeline-be- in the name. If you can't see it off hand, click on the refresh button that's on top of the search bar to the right.

6. Install Dependencies

   pipenv install

7. Run Migrations

   python manage.py migrate

8. Start Project

   python manage.py runserver

9. View the API

   Performing system checks...
   
   System check identified no issues (0 silenced).
   February 09, 2023 - 15:41:00
   Django version 4.1.6, using settings 'pipeline.settings'
   Starting development server at http://127.0.0.1:8000/ # <= API URL
   Quit the server with CONTROL-C.

Documentation

To view the API Documentation, start the server and go to "http://127.0.0.1:8000/docs/#"