ani-track

command module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 20, 2024 License: MIT Imports: 15 Imported by: 0

README ΒΆ

πŸš€ AniTrack - A MyAnimeList CLI Client

A command line client built with Go that interfaces MyAnimeList API for viewing top anime, anime details, updating user's anime lists and more


πŸ“Œ Prerequisites

  • MyAnimeList Account is required to obtain ClientId and ClientSecret.

πŸ”§ Configuration

To get started, you'll need a 'Client ID' and 'Client Secret' from MyAnimeList's API Dashboard:

  1. πŸ”— Navigate to: MyAnimeList API Dashboard

  2. πŸšͺ Sign in or create a MyAnimeList account.

  3. βž• Click on 'Create ID'

  4. πŸ“œ Fill in the app details like example below.

MAL API Client Example

  1. 🌐 In the App Redirect URL field of the app you created, please enter the following URLs:

    • πŸ“Ž http://localhost:9999/oauth/callback
  2. πŸ› Once the App is created, you'll find the 'Client ID' and 'Client Secret' on the app details page.

  3. πŸ”‘ Add Credentials in .env:

    • Create a .env file in the root directory of this project and copy these values by adding your MAL client id and client secret.
# MAL
MAL_CLIENT_ID="<CLIENT ID GOES HERE>"
MAL_CLIENT_SECRET="<CLIENT SECRET GOES HERE>"
REDIRECT_URL="http://localhost:9999/oauth/callback"

🚫 Remember: Keep your 'Client Secret and Client Id' confidential. Never share it! They can be used to control your MyAnimeList data.


πŸ“ TODO List

  • Setup oauth with MyAnimeList API
  • Use access token to authenticate User's requests and refresh token when access token expired
  • Add methods for calling different API endpoints of MAL
  • Integrate Cobra and add CLI commands to use different methods
  • Improve UI of the CLI results

πŸ’» Local Development

  1. Install Go version 1.21 or above https://go.dev/
  2. Clone repo
  3. Run go mod tidy
  4. Follow Configuration steps mentioned above
  5. Now oauth with MyAnimeList can be executed from root directory e.g. go run main.go

🀝 Contributing

Your contributions are welcome! 🌟 Feel free to submit pull requests or raise issues.


πŸ“œ License

This project is under the MIT License. Dive into the LICENSE file for more.

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL