Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codewithmike01/online-note-book-drf

Last synced: 30 days ago
JSON representation

Host: GitHub
URL: https://github.com/codewithmike01/online-note-book-drf
Owner: codewithmike01
Created: 2023-09-20T19:28:30.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2023-11-08T07:22:12.000Z (almost 1 year ago)
Last Synced: 2024-08-20T16:43:28.477Z (3 months ago)
Language: JavaScript
Size: 15.5 MB
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# API Development and Documentation Tunga Accessment

## Online Note App

The online Notes is be use by staff to log thier personal notes. The online note app is developed using Django Rest Framework (DRF).

https://github.com/Ginohmk/online-note-book-drf/assets/58771507/3b1a8781-2fa2-4ddf-9a96-427772144469

### Live link

Hosted on aws, [live link](http://44.241.249.189:8000/api/schema/docs/) to swagger doc

#### Test passed ( used pytest)

![image](https://github.com/Ginohmk/online-note-book-drf/assets/58771507/d2aa578b-0069-4b35-8420-7c44a77cc980)

### Features

1. User Registration - User should be able to register with the follwing details:

- First name
- Last name
- Email
- Password

2. User login: User can log in with:

- Email
- Password

3. Password recovery: users can recovery password when forgotton, by updating/reseting password using `Email link`.

4. User can perform CRUD operation on Dairy notes beloging to them.

5. User can order notes based on lastest

6. User can filter notes based on:

- Unfinished
- Overdute notes
- Done notes

7. Sort all note by:

- Due date
- Priority
- Created-time

8. Export notes list to pdf and csv

9. Share or publish the notes over an email

10. Set email reminder for notes

## Starting

##### Prerequisite

- Note: You need to have python3.x [installed](https://www.tutorialspoint.com/how-to-install-python-in-windows) on you machine.

##### Steps

1. Clone the project into your machine.

```cmd
git clone https://github.com/Ginohmk/online-note-book-drf.git
```

2. Navigate into the project folder.

```cmd
cd online-note-book-drf
```

3. Start your virtual environment (mac/linux and windows)

```cmd
source/bin/activate
```

Or for windows

```cmd
\venv\Scripts\activate.bat
```

4. Install project dependencies.

```cmd
pip install -r requirements.txt
```

5. Start server

```
./manage.py runserver
```

###### Alternative startup

They is a build.sh script that can be used to setup and run the project for you, following the steps below

1. Clone the project into your machine.

```cmd
git clone https://github.com/Ginohmk/online-note-book-drf.git
```

2. Navigate into the project folder.

```cmd
cd online-note-book-drf
```

3. Start your virtual environment (mac/linux and windows)

```cmd
source/bin/activate
```

Or for windows

```cmd
\venv\Scripts\activate.bat
```

4. Make build.sh executable

```cmd
chmod +x build.sh
```

5. Run the excutable script

```cmd
./build.sh
```

##### Key Note

This application may not work as it should on your local machine, Due to the fact that it is missing some environment variables, This variable are private to a user and as such i have created a spot for you to input yours by editing the `Enter yours` found in settings.py. You can it on the following:

- SECRET_KEY
- JWT_KEY
- EMAIL_HOST_USER : For this you can use your personal email address(G-mail).
- EMAIL_HOST_PASSWORD: For this you can use you email(G-mail) [App Password](https://support.google.com/mail/answer/185833?hl=en#:~:text=Under%20%22Signing%20in%20to%20Google,Select%20Generate.)

### Folder Structure

This are the folders and files relevant to this project.

```doc
├── drf # Project file
├── settings.py
├── urls.py
├── note # Note app

├── admin.py
├── models.py
├── serializers.py
├── services.py
├── urls.py
├── views.py
├── users # User app
├── admin.py
├── authentication.py # Custom authentication
├── models.py
├── permission.py # Custom permision
├── serializers.py
├── services.py
├── urls.py
├── views.py
├── build.sh
├── manage.py
├── README.md
├── requirements.txt
```

### Backend APIs

##### Swagger Docs

`/api/schema/docs/`

##### User Apis

1. Registration `/api/users/register/` (Post)

- Payload

```json
{
"id": "string",
"first_name": "string",
"last_name": "string",
"email ": "string",
"password": "string",
"is_email_verified": boolean
}
```

- Response 200

```json
{
"id": "string",
"first_name": "string",
"last_name": "string",
"email ": "string",
"is_email_verified": false
}
```

2. Login `/api/users/login/` (Post)

- Payload

```json
{
"email": "string",
"password": "string"
}
```

- Response 200

3. Logout `/api/users/logout/` (Post)

- Payload `None`

- Response 200

```json
{
"message": "Logged out Successfully"
}
```

4. Me `/api/users/me/` (Get)

- Payload `None`

- Response 200

```json
{
"id": "string",
"first_name": "string",
"last_name": "string",
"email ": "string",
"is_email_verified": boolean
}
```

5. Email verification `/api/users/verify-email/` (Post)

`Note: Verification link is sent to user and when clicked they can verify thier email`

- Payload `None`

- Response 200

5. Request password reset link `/api/users/request-password-reset/` (Post)

`Note: Passsword Reset link is sent to user`

- Payload `None`

- Response 200

5. Confirm and reset password `/api/users/reset_password_confirm///` (Post)

`Note: Passsword Reset link is sent to user`

- Payload

```json
{
"token": "string",
"uidb64": "string",
"password": "string"
}
```

- Response 200

```json
{
"id": "string",
"first_name": "string",
"last_name": "string",
"email ": "string",
"is_email_verified": boolean
}
```

##### Note Apis

1. Create note `/api/notes/create/` (Post)

`Note: priority accepts min = 1 and max = 10`

- Payload

```json
{
"title": "string",
"content": "string",
"due_date": "string datetime",
"is_complete": boolean,
"priority": int
}
```

- Response 200

```json
{
"id": "uuid string",
"title": "string",
"content": "string",
"created_at": null,
"due_date": "string datetime",
"priority": int,
"is_complete": boolean,
"user": {
"id": "string",
"first_name": "string",
"last_name": "string",
"email": "string"
}
}
```

2. Get user notes `/api/notes/create/` (Get)

- Response 200

```json
[
{
"id": "uuid string",
"title": "string",
"content": "string",
"created_at": null,
"due_date": "string datetime",
"priority": int,
"is_complete": boolean,
"user": {
"id": "string",
"first_name": "string",
"last_name": "string",
"email": "string"
}
}
]
```

3. Get all notes `/api/notes/` (Get)

- Response 200

4. Delete note `/api/notes//` (Delete)

- Response 204

5. Update note `/api/notes//` (Put)

- Payload

```json
{
"title": "string",
"content": "string",
"due_date": "string datetime",
"is_complete": boolean,
"priority": int
}
```

- Response 200

5. Retreive note `/api/notes//` (Get)

- Response 200

### Author

👤 **Kanu Mike**

- GitHub: [@Ginohmk](https://github.com/Ginohmk)
- Twitter: [@michotall95](https://www.twitter.com/michotall95)
- LinkedIn: [@kanumike](https://www.linkedin.com/in/mike-kanu-dev/)
- Instagram: [@savy_kanu_mike](https/instagram.com/savy_kanu_mike)
- Facebook: [@mike.kanu](https://www.facebook.com/mike.kanu)

### 🤝 Contribute

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Ginohmk/online-note-book-drf/issues)

### Acknowledgement

I want to acknowledge Tunga Impact Academy, for thier support, training and for time taken to nuture and improve my backend skill as a Django Rest Framework Developer.

## Show your support

Give a ⭐️ if you like this project!

## 📝 License

This project is [MIT](./MIT.md) licensed.