https://github.com/diable201/weebnet
Django Project for Django Framework course
https://github.com/diable201/weebnet
backend django djangorestframework jwt postgresql postman-collection python rest-api
Last synced: 2 months ago
JSON representation
Django Project for Django Framework course
- Host: GitHub
- URL: https://github.com/diable201/weebnet
- Owner: diable201
- License: mit
- Created: 2022-04-30T10:41:23.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-10T08:36:19.000Z (about 4 years ago)
- Last Synced: 2025-03-11T04:32:45.299Z (over 1 year ago)
- Topics: backend, django, djangorestframework, jwt, postgresql, postman-collection, python, rest-api
- Language: Python
- Homepage:
- Size: 5.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Django Project
> ***Tech Otakus Save The World***
>
>
> $MiHoYo$
>
---
# Weebnet
---
## Main Idea
---
💡 The idea is to create an anime encyclopedia (database).
This includes anime TV series, feature films, and manga. The goal is to create a convenient API for quickly viewing the information you need. The project was inspired by sites such as shikimori.one, MyAnimeList, AniDB etc.
## Requirements
1. Class diagram with all relations between entities
2. Minimum 6 models
a. model inheritance
b. abstract model
3. Minimum 4 model Manager
4. Minimum 6 relations between models (ForeignKey)
5. JWT Auth, Profile
6. Serializer
* a. at least 2 from serializer.Serializer
* b. at least 2 serializer from serializer.ModelSerializer
* c. at least 4 Serializer inheritance
* d. at least 6 validations
* e. Nested serializer
7. Views
* a. at least 2 FBV view
* b. at least 4 CBV APIView
* c. at least 6 ViewSet
* d. File Upload views
8. Django Signals - at least 4 usage
9. Logging module for each app
10. Well structured Postman requests with all implemented methods
* a. separated by Folders
* b. using Environment variables (ex: token)
### Django Side
1. Install `virtualvenv` if you don't have it
``` Shell
$ pip install virtualenv
```
2. Create virtualenv
``` Shell
$ virtualenv .venv
```
3. Activate virtualenv
``` Shell
$ source .venv/bin/activate
```
4. Then can install all the required dependencies:
``` Shell
$ cd Weebnet
$ pip install -r requirements.txt
```
## Run The App
To start the backend django server run
``` Shell
python manage.py runserver
```
From the `Weebnet` folder. Server will be running on `http://localhost:8000/`
## Models
---
🚀 There can be models with which you can make **CRUD** operations like:
1. Anime
2. Manga
3. Ranobe
4. Genres
5. User
6. Comments
---
## Demo API
👘 This is just predicted example of `GET` request via **Postman**
---
---
## Database
🐘 Did you really name your son `Okabe; DROP TABLE users;`
> PostgreSQL has been designed to reliably store your most valuable asset – your data.
- Benefits of PostgreSQL
- Open Source
- Reduce Costs
- Security
- Scalability
---
## Endpoints
🦉 Corrects endpoints always better than incorrect endpoints
| Endpoint | Description |
| --- | --- |
| GET /api/anime/ | List of all anime |
| GET /api/anime/:id/ | Show an anime by id |
| GET /api/characters/search/ | Search characters |
| GET /api/users/ | List users |
| POST /api/anime/:id/comments/ | Create a comment |
---
## Deploy
🚢 There are many **cloud computing** services: DigitalOcean, Microsoft Azure, AWS, etc...
If I will have enough time I would deploy my backend API on some cloud server. I think it should be good practice for me as backend developer.
### ← **No, not this one Azure**
### **you didn’t see anything**
### This one is correct →
---
## Conclusion
🔚 If you've read this far, I feel sorry for you.
Let’s summarize. The report has described the Django project “**Weebnet”**. And maybe (who knows?) one day such an application as "Weebnet" will really appear in the world and will unite all weeb people around the world! Thank you for your attention.
---
## License
This repository is released under the [MIT license](LICENSE.md). In short, this means you are free to use this software in any personal, open-source or commercial projects. Attribution is optional but appreciated.
```jsx
let sanzhar = {
pronouns: "He" | "Him",
code: ["Python", "C#", "Java", "Golang"],
askMeAbout: ["backend dev", "student", "anime"],
technologies: {
mobileApp: ["Kotlin"],
frontEnd: {
js: ["Angular"],
css,
html,
},
backEnd: {
Golang,
Python: ["Django", "FastAPI"],
},
devOps: ["Docker🐳"],
databases: ["mongoDB", "PSQL"],
deploy: ["DigitalOcean", "AWS", "Azure", "Oracle"]
},
currentProject: "Weebdev 🍡",
funFact: "I am not funny",
};
```