https://github.com/adityaswarupparida/restapi-project
Notes API, a Django RESTful API
https://github.com/adityaswarupparida/restapi-project
django-rest-framework python3 rest-api
Last synced: 12 months ago
JSON representation
Notes API, a Django RESTful API
- Host: GitHub
- URL: https://github.com/adityaswarupparida/restapi-project
- Owner: adityaswarupparida
- Created: 2022-01-31T17:42:25.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-01T08:20:59.000Z (over 4 years ago)
- Last Synced: 2025-06-16T15:43:48.341Z (about 1 year ago)
- Topics: django-rest-framework, python3, rest-api
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RestAPI-project
This repo has the code for a Notes API, my first Django RESTful API project. Hope you liked it.
## To Run on Localhost:
- Have `Python` and `pip` installed on your local machine
## Running the Django project:
Create an isolated environment for the project with `virtualenv`. You can install `virtualenv` with the following command:
```
pip install virtualenv
```
Clone the project from GitHub:
```bash
git clone https://github.com/Adiswat/RestAPI-project
```
Navigate to the cloned project directory:
```
cd RestAPI-project
```
Create a virtual environment for the project:
```bash
virtualenv venv
```
Then, activate it:
```bash
.\venv\Scripts\activate (for Windows user)
```
Install Django and Django REST Framework:
```bash
pip install -r requirements.txt
```
Finally, `cd` into the *notes_app* folder and run the project:
```bash
python manage.py runserver
```
Go to http://localhost:8000/api/ to see if the API is up and running to create notes:):
You can add notes and refresh the webpage to see the added notes. Then, view the created notes at 127.0.0.1:8000/api/id (e.g. http://127.0.0.1:8000/api/3/):
You can also **delete** or **update** the note on the detail page using the **delete** and **put** button respectively. **Thank you:)**
**Eureka! We have completed our first REST API project.**
**Happy Coding:)**