Ani-Oke

"Sing along to your favorite anime hits with Ani-oke"
View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact
7. Acknowledgments

About The Project

Ani-oke is a webapp that allows users to play anime openings and endings using Spotify's web API. The app also generates romanized lyrics for the selected song using web scraping from various lyrics websites. With Ani-oke, users can sing along to their favorite anime songs, even if they don't know how to read Japanese. The app is perfect for anime fans who want to practice their singing skills or just have some fun with their friends. Simply search for an anime song, and Ani-oke will take care of the rest!

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

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

Prerequisites

You will need the following software.

For Node

• npm

  npm install npm@latest -g

For Flask

• pip

python -m pip install --upgrade pip.

Installation

Below are the instructions to setup the project locally , don't forget to cd to the respective folders mentioned.

1. Create a Spotify Developer Account, and generate the Client Secret and Client ID then Set Redirect URI - http://localhost:3000
2. Clone the repo

   git clone https://github.com/Malay-dev/spotify-x-ani-oke.git

3. Install NPM packages in the server

   cd server
   npm install

4. Create a '.env' in server folder and enter your API according to the sample '.env' template

   REDIRECT_URI=http://localhost:3000
   CLIENT_ID=ENTER YOUT CLIENT ID
   CLIENT_SECRET=ENTER YOUR CLIENT SECRET

5. Start the Nodemon server in Server folder

   npm run start:dev

6. Install required libraries in flask-server

   cd flask-server
   python3 -m venv /path/to/new/virtual/environment
   pip install -r requirements.txt

7. Start the flask-server

   py app.py

8. Install NPM packages in client - frontend

   cd client
   npm install

9. Start the frontend

   npm run start

NOTE: Song streaming feature will only work if you have premium spotify account.

(back to top)

Roadmap

• Add Readme
• Add footer
• Make the site responsive
• Add playlist feature
• Improve lyrics generation
• Improve Song Streaming Service

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the GNU License. See LICENSE.txt for more information.

(back to top)

Contact

Utsav Yadav - @Yadavutsav3 Malay Kumar - @void_MalayK

NOTE: To enjoy the demo link please contact above for required permissions.

Project Link: https://github.com/Malay-dev/spotify-x-ani-oke

back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• Img Shields
• Render
• Netlify
• Spotify Web API
• Genius
• Fonts

(back to top)