https://github.com/vlymar-dev/jornaly_api
API of the Social Network for publishing personal diaries
https://github.com/vlymar-dev/jornaly_api
cors-headers django-filter django-rest-framework djoser flake8 isort pillow python simplejwt
Last synced: 6 months ago
JSON representation
API of the Social Network for publishing personal diaries
- Host: GitHub
- URL: https://github.com/vlymar-dev/jornaly_api
- Owner: vlymar-dev
- License: mit
- Created: 2024-07-17T16:44:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-22T17:48:56.000Z (over 1 year ago)
- Last Synced: 2025-06-09T01:33:31.712Z (7 months ago)
- Topics: cors-headers, django-filter, django-rest-framework, djoser, flake8, isort, pillow, python, simplejwt
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.python.org/)
[](https://www.django-rest-framework.org/)
[](https://www.postgresql.org/)
[](https://www.docker.com/)
[](https://www.docker.com/)
[](https://www.nginx.com/)
[](https://pypi.org/project/psycopg2-binary/)
[](https://gunicorn.org/)
[](https://djoser.readthedocs.io/en/latest/getting_started.html)
[](https://flake8.pycqa.org/en/latest/)
[](https://pycqa.github.io/isort/)
# JornalY_API
### Table of contents:
- [Project Description](#Project-Description)
- [Getting Started](#Getting-Started)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Project Description
***Built with Django 5 and Django REST Framework (DRF), this web application offers robust functionality for managing users, posts, and social interactions through a RESTful API.***
***Key features include:***
**Post Management**
- Create Posts: Users can create new posts and attach images to them.
- Edit Posts: Authors can edit the content of their own posts.
- Comments: Users can add comments to posts.
- Tags: Users can create and assign tags to posts to categorize content.
**Social Features**
- Subscriptions: Users can subscribe to and unsubscribe from other authors to follow their posts.
**Testing**
- All features have been thoroughly tested to ensure reliability and functionality.
## Getting Started
**To get started with the project, follow these steps:**
1. Clone the repository and navigate to the project directory:
```sh
git clone https://github.com/dev-lymar/JornalY_API.git
cd JornalY_API
```
2. Configure .env
```sh
replace env.example with your data
```
3. Install [`Docker`](https://www.docker.com/)
and [`Docker Compose`](https://docs.docker.com/compose/) for your operating system.
4. Start the project from root directory:
```sh
docker-compose up -d --build
```
5. Execute the commands one at a time:
```sh
docker-compose exec web python manage.py migrate
docker-compose exec web python manage.py createsuperuser
docker-compose exec web python manage.py collectstatic --no-input
```
#### Open your web browser and navigate to http://localhost:80 to access the application.
## Usage
Once the development server is running, you can access the API at http://127.0.0.1:80/.
You can use tools like curl, Postman, or any REST client to interact with the API endpoints.
For example, to view the list of posts, you can send a GET request to /api/v1/posts/, and you will receive a list of posts.
## Contributing
If you would like to contribute to this project, please fork the repository and submit a pull request.
For major changes, please open an issue first to discuss what you would like to change.
## License
This project is licensed under the MIT License. See the LICENSE file for details.