AjayLiu / ichiban

an anime popularity guessing game

Ichiban

Which anime is more popular? Naruto or Demon Slayer? See how well you can correctly guess the popularity of the most popular animes!
Play now »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Development
   • Deployment
3. License
4. Contact
5. Acknowledgements

About The Project

The top 75 most popular animes are fetched from Jikan API. They are randomized and matched up with each other. High scores are stored in a MongoDB database.

Built With

• Next.js
• React
• SCSS
• Netlify
• MongoDB

Getting Started

Here is a guide if you want to clone my website and modify it for yourself, all the way to deployment.

Prerequisites

• yarn
• git

Installation

1. Clone the repo

   git clone https://github.com/AjayLiu/ichiban.git

2. Install packages

   yarn

3. Create a .env file in the root and fill in the following information about your MongoDB database:

   USER=
   PASSWORD=
   

Development

To run the development server

yarn dev

Then head over to localhost:3000

To test out the high score functionality, run this instead (install Netlify CLI first):

netlify dev

Deployment

1. Publish the site on Netlify using continuous git integration.
2. Make sure to enter the same environment variables to Netlify.

License

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

Contact

Ajay Liu - [e-mail]

Project Link: https://github.com/AjayLiu/ichiban

Acknowledgements

• Jikan API
• MongoDB Atlas
• Netlify