https://github.com/nsttt/localtracker
A Self-hosted tracker for all your media needs.
https://github.com/nsttt/localtracker
express graphql hacktoberfest javascript react type-graphql typescript
Last synced: about 2 months ago
JSON representation
A Self-hosted tracker for all your media needs.
- Host: GitHub
- URL: https://github.com/nsttt/localtracker
- Owner: Nsttt
- License: mit
- Created: 2021-07-25T11:38:25.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-06-24T16:39:05.000Z (almost 4 years ago)
- Last Synced: 2025-03-06T04:13:09.222Z (about 1 year ago)
- Topics: express, graphql, hacktoberfest, javascript, react, type-graphql, typescript
- Language: Go
- Homepage:
- Size: 648 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.MD
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Stargazers][stars-shield]][stars-url]
[![Web Issues][web-issues-shield]][web-issues-url]
[![API Issues][api-issues-shield]][api-issues-url]
[![MIT License][license-shield]][license-url]
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](https://twitter.com/nstlopez) 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.
## 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.
## 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`.
```sh
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](./packages/api/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](./packages/web/README.md).
## 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.**
## Roadmap
Refer to [Roadmap](https://github.com/Nsttt/localtracker/projects/3).
## Contact
- [@nstlopez](https://twitter.com/nstlopez) on Twitter.
- By [mail](mailto:nestor@nstlopez.com).
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Acknowledgments
Currently empty, I'll fill this when we start using 3rd party APIs and such.
[contributors-shield]: https://img.shields.io/github/contributors/nsttt/localtracker?style=for-the-badge
[contributors-url]: https://github.com/nsttt/localtracker/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/nsttt/localtracker?style=for-the-badge
[forks-url]: https://github.com/nsttt/localtracker/network/members
[stars-shield]: https://img.shields.io/github/stars/nsttt/localtracker?style=for-the-badge
[stars-url]: https://github.com/nsttt/localtracker/stargazers
[api-issues-shield]: https://img.shields.io/github/issues/nsttt/localtracker/api?style=for-the-badge
[api-issues-url]: https://github.com/nsttt/localtracker/issues?q=is%3Aopen+is%3Aissue+label%3Aapi
[web-issues-shield]: https://img.shields.io/github/issues/nsttt/localtracker/web?style=for-the-badge
[web-issues-url]: https://github.com/nsttt/localtracker/issues?q=is%3Aopen+is%3Aissue+label%3Aweb
[license-shield]: https://img.shields.io/github/license/nsttt/localtracker?style=for-the-badge
[license-url]: https://github.com/nsttt/localtracker/blob/master/LICENSE.txt
[product-screenshot]: images/screenshot.png