This API connects users with mentor. It is developed using Django rest framework. You can find the api [here]([https://web-production-b715.up.railway.app/api/schema/docs/].
- Custom
User
model and authentication using email and password. - JWT authentication.
- Mentors List, detail endpoint.
- Search functionality based on skills and hourly rate.
- email verfication
- Documentation using
drf_spectacular
which support OAS3. - Frontend is built using React.js and can be found here.
To get this project up and running locally on your computer follow the following steps.
- Clone this repository to your local machine.
- Create a python virtual environment and activate it.
- Open up your terminal and run the following command to install the packages used in this project.
$ pip install -r requirements.txt
- Set up a Postgres database for the project.
- Rename the
.env.example
file found in the root directory of the project to.env
and update the environment variables accordingly. - Run the following commands to setup the database tables and create a super user.
$ python manage.py migrate
$ python manage.py createsuperuser
- Run the development server using:
$ python manage.py runserver
- Open a browser and go to http://localhost:8000/.
Usage is provided under the MIT License. See LICENSE for the full details.