An open API service indexing awesome lists of open source software.

https://github.com/genebit/plantasker

A gamified simple todo application that plant trees.🌱 Built using React and Firebase.
https://github.com/genebit/plantasker

firebase react shadcn-ui vite

Last synced: 2 months ago
JSON representation

A gamified simple todo application that plant trees.🌱 Built using React and Firebase.

Awesome Lists containing this project

README

          

![Planttasker Logo](/public/favicon/apple-icon-72x72.png "Logo")

## Plantasker: Growing Trees with Tasks

[View Live Demo](https://planttasker.web.app) • [Report a Bug](https://github.com/genebit/plantasker/issues)

Table of Contents

1. [About the Project](/README.md)

- [Built With](/README.md#technology-stack)
- [Resources Used](/README.md#resources-used)

2. [Getting Started](/README.md#getting-started-📌)

- [Prerequisites](/README.md#prerequisites)
- [Installation](/README.md#installation)

3. [License](/README.md#license-✍)

#### **About**

This repository is simple todo (learning React) application that utilizes the browser's local storage.

#### **Technology Stack**

![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)
![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)
![Firebase](https://img.shields.io/badge/Firebase-039BE5?style=for-the-badge&logo=Firebase&logoColor=white)
![Typscript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![Nodejs](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)

#### **Resources Used**

[![Skills](https://skillicons.dev/icons?i=git,github,figma,vite,firebase,vscode)](https://skillicons.dev)

## **Getting Started** 📌

#### Prerequisites

Before running the application, make sure to install the following:

1. NodeJS (NPM).

Download through their official [docs](https://nodejs.org/en/download).

```bash
npm install npm@latest -g
```

#### Installation

1. Clone this repository

```bash
git clone https://github.com/genebit/plantasker.git
```

Upon cloning, bavigate to the repo.

2. Install NPM packages

```bash
npm install
```

That's it! You can now start by running the application.

3. Start the application
```bash
npm run dev
```

### Firebase Deployment

1. Initialize Firebase config. Answer the prompt and redirect it from `public` to `dist`. Because dist is the output build file for vite
```bash
firebase init
```

2. Build the repo.
```bash
npm run build
```

3. Deploy to Firebase
```bash
firebase deploy
```

## **License** ✍

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