joshxfi / track-as-one

A collaborative task tracker for you and your friends.

About

trackAsOne 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. This project is a Progressive Web App (PWA) and you can install it as a mobile or desktop app. Installation Guide (optional)

Contributing

If you want to contribute, make sure to review our CODE OF CONDUCT. For bugs and feature requests, feel free to open an issue.

1. Fork this repository and clone your fork.
2. Create a new branch for your changes:

$ cd <your_cloned_fork>
$ git checkout dev
$ git checkout -b my-new-branch

• To create another branch:

$ git checkout dev
$ git pull
$ git checkout -b my-new-branch

3. Create a .env.local file with this content:

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:

# NOTE: use yarn when installing dependencies
$ yarn
$ yarn dev

5. Commit your changes and push your branch.

$ 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.