README.md

AnimeSuper: ultimate hub for anime fans, seamless platform to organize favorites, and stay updated on trends.😊

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• Code of conduct
• License
• Project Links

About The Project

Built With

Frontend

• React
• Figma
• Iconify
• React Intersection Observer
• Redux Toolkit
• Swiper
• React Image File Resizer
• Firebase

Backend

• Django
• Django Rest Framework
• MyAnimelist API

Getting Started

Prerequisites

Git is a distributed version control system used for software development. It allows multiple developers to work on the same codebase simultaneously, keeping track of changes and managing versions. It also enables users to revert changes and collaborate more effectively.

Python is a high-level, general-purpose programming language. Its design philosophy emphasizes code readability with the use of significant indentation. Python is dynamically typed and garbage-collected. It supports multiple programming paradigms, including structured, object-oriented and functional programming.

Installation

Step 1 - Clone the animesuper project.

git clone https://github.com/prince2520/animesuper.git

Frontend

Step 2 - Install the necessary dependencies.

npm install 

Step 3 - Add environment variables.

# Create .env file and paste to root folder

# Add the url of your server
REACT_APP_SERVER_URL= https://127.0.0.1:8000

# Add your firebase credentials here
# firebase config (Add your config data)
REACT_APP_apiKey=*****
REACT_APP_authDomain=*****
REACT_APP_projectId=*****
REACT_APP_storageBucket=*****
REACT_APP_messagingSenderId=*****
REACT_APP_appId=*****
REACT_APP_measurementId=*****

Step 4 - Run frontend server locally.

npm start 

Backend

Step 5 - Install the necessary dependencies.

pip install -r requirements.txt 

Step 6 - Add environment variables.

# add .env file to animesuper directory

# add your myanimelist api credentials
MYANIMELIST_URL=https://api.myanimelist.net
MYANIMELIST_API_KEY==******

# email credentials 
EMAIL_USE_TLS=True
EMAIL_HOST=smtp.gmail.com
EMAIL_HOST_USER=******
EMAIL_HOST_PASSWORD=******
SENDER_EMAIL=******
EMAIL_PORT=587


# add your yugabyte credentials
DB_ENGINE=django_yugabytedb
DB_NAME=yugabyte
DB_HOST=******
DB_PORT=5433
DB_CONN_MAX_AGE=None
DB_USER=admin
DB_PASSWORD=******

Step 7 - Run backend server locally.

py manage.py runserver 8000

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it

• Please make sure you check your spelling and grammar.

Creating A Pull Request

Wanna contribute to AnimeSuper ?

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/FeatureName)
3. Commit your Changes (git commit -m 'Add some FeatureName')
4. Push to the Branch (git push origin feature/FeatureName)
5. Open a Pull Request

Code of conduct

Developers are requested to go through our code of conduct thoroughly to maintain a peaceful environment within our project.

License

Distributed under the MIT License. See LICENSE for more information.

Project Links