Skip to content

edwincarr/AniTracker

Repository files navigation


Ani-Tracker

Ani-Tracker is a Social-cataloging website to track previously watched or planning to watch anime inspired by Anilist.co
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contact

About The Project

Screenshot 2022-05-21 164546

(back to top)

Built With

API

AniList API

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

  1. Clone the repo

    git clone [email protected]:edwincarr/AniTracker.git
  2. Install Dependencies in the root folder

    pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt
  3. Install NPM packages inside of the react-app folder

    npm install
  4. Create a PSQL user with CREATEDB PASSWORD

    CREATE USER <name> WITH CREATEDB PASSWORD <'password'>;
  5. Create a PSQL Database with the user in the last step as the owner

    CREATE DATABASE <name> WITH OWNER <user>;
  6. Create a .env file to access the backend based on the .env.example within the respective directory

    • input desired information into .env
  7. Get into Pipenv

    pipenv shell
  8. Migrate and seed models.

    flask db upgrade
    flask seed all
  9. Start the backend in the backend directory

    flask run
  10. Start the frontend in the frontend directory, this should open the project in your default browser. If not, navigate to http://localhost:3000

    npm start
  11. From here you can create and sign in as a user and begin using Ani-Tracker

(back to top)

Contact

Project Link: https://github.com/edwincarr/AniTracker