mandharet / notes-crud

Django REST API

User Authentication APIs 🔗

Notes CRUD APIs 🔗

Python: 3.9.5

Setting Up Local Development Environment

1. Setting Up using venv

2. Setting Up using docker

---

Setting Up using venv

1. Clone the Repository

git clone https://github.com/mandharet/notes-crud
cd ./notes-crud

2. Create a Virtual Environment (Optional but Recommended)

# Install virtualenv if not already installed
pip install virtualenv

# Create a virtual environment
python -m venv venv

# Activate the virtual environment
# On Windows
venv\Scripts\activate
# On Unix or MacOS
source venv/bin/activate

3. Install Dependencies

pip install -r requirements.txt

This command installs all the required Python packages specified in the requirements.txt file.

4. Run Migrations

python manage.py makemigrations
python manage.py migrate

This command applies any pending database migrations.

5. Create a Superuser (Optional)

python manage.py createsuperuser

This command creates a superuser account for administrative access to the Django admin interface.

6. Run the Development Server

python manage.py runserver

This command starts the development server. You can access the Django development server at http://127.0.0.1:8000/.

7. Explore the API

Explore the API using tools like Postman or by visiting the provided Django admin interface at http://127.0.0.1:8000/admin/ (login with superuser credentials).

---

Setting Up using docker

• TODO:create Dockerfile

---