anime-library

Content Table

• About
• Requirements
• Techstack

🚧 Anime Library 🚀 Under development... 🚧

About

The anime library is a website that helps you keep track of your animes - mark an anime as watched, watching or dropped, create a library and share with your friends.

This is a pet project where I toy around with technologies and new concepts I learn. As of now, I'm getting familiar with GraphQL and applying some of the principles of SOLID pattern.

Features

• GraphQL API
  • User creation
  • User profile
  • Anime creation
  • Add anime to user library
  • Reviews & Rating
  • Comments
• Rest API

Requirements

Before you start, you'll need the following tools installed: Git, Node.js, Docker, VSCode.

P.S.: You'll also need MAKE if you happen to be on Windows.

🎲 Setting up the server

# Clone this repo
$ git clone https://github.com/hanar3/anime-library

# cd into the project folder terminal/cmd
$ cd anime-library

# cd into the server folder
$ cd server

# Install the dependencies
$ npm install

# Run tests
$ npm run test

# Set up the database and run the application in development mode (don't forget to edit your .env file!)
$ make up

# Create the database tables
$ make migrate

# The server will start running on port 4000 - go to <http://localhost:4000/graphql> to start writing graphql queries

🎲 Setting up the client

# Clone this repo
$ git clone https://github.com/hanar3/anime-library

# CD into the project folder terminal/cmd
$ cd anime-library

# cd into the client folder
$ cd client

# Install the dependencies
$ npm install

# Run the application in development mode
$ npm start

# The server will start running on port 8080 - go to <http://localhost:8080/>

🛠 Tech Stack

The following tools were used to build this project:

• Node.js
• Svelte
• TypeScript
• GraphQL
• Type GraphQL