Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joshxfi/track-as-one
A collaborative task tracker for you and your friends.
https://github.com/joshxfi/track-as-one
firebase nextjs pwa task-tracker
Last synced: 2 months ago
JSON representation
A collaborative task tracker for you and your friends.
- Host: GitHub
- URL: https://github.com/joshxfi/track-as-one
- Owner: joshxfi
- License: gpl-3.0
- Created: 2021-09-14T02:26:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-16T12:23:05.000Z (about 2 years ago)
- Last Synced: 2023-03-04T23:02:36.999Z (almost 2 years ago)
- Topics: firebase, nextjs, pwa, task-tracker
- Language: TypeScript
- Homepage: https://tao.joshxfi.tech/
- Size: 1.21 MB
- Stars: 17
- Watchers: 1
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## About
[trackAsOne](https://tao.joshxfi.tech/) is a collaborative platform for tracking school activities or homework along with your friends or classmates. You can create up to 5 rooms and invite your friends! Add due dates, URLs, and images to your tasks for your convenience. You can also assign room admins to help you manage your room.
## Installation
You can use this application using your browser, visit [tao.joshxfi.tech](https://tao.joshxfi.tech/). This project is a Progressive Web App (**PWA**) and you can install it as a mobile or desktop app. [Installation Guide](https://support.google.com/chrome/answer/9658361) (optional)
## Contributing
If you want to contribute, make sure to review our [CODE OF CONDUCT](https://github.com/joshxfi/trackAsOne/blob/main/CODE_OF_CONDUCT.md). For bugs and feature requests, feel free to [open an issue](https://github.com/joshxfi/trackAsOne/issues).
1. Fork this [repository](https://github.com/joshxfi/trackAsOne) and clone your fork.
3. Create a new branch for your changes:
```sh
$ cd
$ git checkout dev
$ git checkout -b my-new-branch
```
- To create another branch:
```sh
$ git checkout dev
$ git pull
$ git checkout -b my-new-branch
```
3. Create a `.env.local` file with this content:
```sh
NEXT_PUBLIC_API_KEY=AIzaSyD0nP1qf9Fhi0jCH8YM99LTJEeKAqWiuL4
NEXT_PUBLIC_AUTH_DOMAIN=trackasone-dev.firebaseapp.com
NEXT_PUBLIC_PROJECT_ID=trackasone-dev
NEXT_PUBLIC_STORAGE_BUCKET=trackasone-dev.appspot.com
NEXT_PUBLIC_MESSAGING_SENDER_ID=293327465838
NEXT_PUBLIC_APP_ID=1:293327465838:web:6ab9ecc3289a0f24e6257f
NEXT_PUBLIC_MEASUREMENT_ID=G-P87XJ4TX93
```
5. To run locally:
```sh
# NOTE: use yarn when installing dependencies
$ yarn
$ yarn dev
```
5. Commit your changes and push your branch.
```sh
$ git add .
$ git commit -m "chore: some changes"
# Make sure to stop the dev server before pushing
$ git push origin HEAD
```
6. Submit a pull request on the `dev` branch. (resolve conflicts if present)
## License
**trackAsOne** is licensed under the [GPL-3.0 license](https://github.com/joshxfi/trackAsOne/blob/main/LICENSE).