YashdalfTheGray / todos

The classic todo app that everyone writes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

todos

The classic todo app that everyone writes.

Setup

Clone the repository down and run npm install to get all the dependencies installed. The other thing to do is to create a Cloud Firestore and create a collection called todos.

Once you have those two things, you're going to want to create a .env file so that certain Firebase requirements can be inlined into the project. The file should have the 3 keys that you see below.

FIREBASE_API_KEY=<api_key>
FIREBASE_PROJECT_ID=<project_id>
FIREBASE_MESSAGING_ID=<messaging_id>

These details will be provided to you when you create a new Firebase project for yourself. Without this information, this project will not work.

Running

A simple npm start will start the server and start webpack-dev-server as well to build the assets. This app will write to your Cloud Firestore.

Development

The patterns in the project are fairly self explanatory, it uses React + Redux + Redux Saga to get the job done. The project also runs prettier so that code style can be enforced and tslint for linting.

Once you're done making your changes, run npm run tslint to run the linter and formatter. This project also includes hooks for running prettier on the code that you have staged. This happens automatically.

Resources

About

The classic todo app that everyone writes

License:GNU General Public License v3.0


Languages

Language:TypeScript 92.9%Language:JavaScript 4.0%Language:HTML 1.9%Language:Dockerfile 1.0%Language:Shell 0.2%