LocalTracker

A media tracking app that fills all your media-tracking needs.
Help with Development ! »

Report Bug · Request Feature · Roadmap

WE'RE CURRENTLY REWRITING THE APP TO GO. THIS README IS CURRENTLY OUTDATED WITH THE PREVIOUS VERSION.

About The Project

LocalTracker aims to solve a personal problem. Media trackers. If you're like me, you probably own one or many accounts on famous tracker DBs for series, anime, music, books etc... Honestly, it's not the best solution, and I haven't found any service that merges all of those topics together. Therefor, I'll do it myself.

The app consists of a Lerna monorepo containing a Backend, Frontend, and if successfull, a mobile app of some sort.

Some key factors:

• The project aims to be self-hosted and fully open-source.
• The project plans to use some of said DBs public APIs, though, if any of those DBs dislikes this, I'll remove them, message me if you're one of them.
• The stack on plan right now is Apollo-Express + Type-GraphQL + TypeORM for the backed. And React for our frontend. More info below.

(back to top)

Contributions

Localtracker is open to contributions, but I recommend creating an issue or replying in a comment to let me know what you are working on first that way we don't overwrite each other.

Please read CONTRIBUTING.md for details on this project.

(back to top)

Packages Overview

Prerequisites

At the moment the whole project relies on yarn workspaces. So, in order for it to work you'll have to install yarn.

npm install yarn@latest -g

Afterwards take a look at the root directory package.json for scripts. The project uses Lerna, so you should be able to launch and work from the root directory.

API

This package contain the whole backend used for the project.

Currently the backend uses the following packages.

• Apollo-express
• Type-graphql
• SQLite
• Type-ORM

For more info on scripts and related refer to the package README.md.

WEB

At the moment the whole web package is in early testing. Not sure if we will stick with our current setup, so take this as a grain of salt.

Currently the frontend uses the following packages.

• Next.JS
• Material-UI 5
• Apollo-client
• Zustand

For more info on scripts and related refer to the package README.md.

(back to top)

Branches

• staging -> All pull requests should be made to this branch.
• production -> This would be the branch that has all the approved and tested changes. Don't touch this branch.

(back to top)

Roadmap

Refer to Roadmap.

(back to top)

Contact

• @nstlopez on Twitter.
• By mail.

(back to top)

License

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

(back to top)

Acknowledgments

Currently empty, I'll fill this when we start using 3rd party APIs and such.

(back to top)