/errand

Task App taken a bit too seriously...

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0

Web App Live GNU License Contributers


Logo

Errand

A Simple task-app created to remind yourself of a daily objective in your aimless life. On a serious note, it is a project to recall basic concepts of react, react hooks, create-read-update-delete operations in databases, to learn firebase and of implementing a design using html and css.

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

Errand Mobile 1 Errand Desktop 1 Errand Desktop 2

(back to top)

Built With

  • React
  • React Router
  • Firebase
  • Vercel
  • HTML5
  • CSS3
  • Vite

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm 
    npm install npm@latest -g

Installation

  1. Set up firebase https://firebase.google.com/
  2. Clone the repo 
    git clone https://github.com/SomnathDas/errand.git
  3. Install NPM packages 
    npm install
  4. Create .env file in root dir of the project and enter the following in .env file 
     VITE_API_KEY="YOUR API_KEY"
 VITE_AUTH_DOMAIN="YOUR AUTH_DOMAIN"
 VITE_PROJECT_ID="YOUR PROJECT_ID"
 VITE_STORAGE_BUCKET="YOUR STORAGE_BUCKET"
 VITE_MESSAGING_SENDER_ID="YOUR MESSAGING_SENDER_ID"
 VITE_APP_ID="YOUR APP_ID"
 VITE_MEASUREMENT_ID="YOUR MEASUREMENT_ID"
  5. Run the app by 
    npm run dev

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GNU Affero General Public License v3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Somnath Das - @instagram_handle

Project Link: https://github.com/SomnathDas/errand

(back to top)

Acknowledgments

(back to top)