Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khanguslee/gtd
Getting Things Done w/ React + Redux
https://github.com/khanguslee/gtd
react realm redux typescript
Last synced: 18 days ago
JSON representation
Getting Things Done w/ React + Redux
- Host: GitHub
- URL: https://github.com/khanguslee/gtd
- Owner: khanguslee
- Created: 2021-02-25T05:42:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-03-05T03:10:12.000Z (over 3 years ago)
- Last Synced: 2024-10-02T11:41:11.189Z (about 1 month ago)
- Topics: react, realm, redux, typescript
- Language: TypeScript
- Homepage:
- Size: 1.23 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Get Things Done
A simple Todo app that aims to let you Get Things Done.
A React, Typescript and Redux project.
## Getting Started
### Pre-Requisites
#### OAuth
The application allows users to sign-in using their own Google Account. This service is completed using MongoDB Realm to handle authentication and uses the Google as the Authentication Provider. Details on setting this up can be seen [here](https://docs.mongodb.com/realm/authentication/google/#set-up-a-project-in-the-google-api-console).
#### Environment Variables
You will need the following `.env` variables set to enable oauth to the application.
| Name | Value |
| ---------------------------- | ----------------------------------------- |
| `REACT_APP_REALM_APP_ID` | Realm App ID |
| `REACT_APP_GOOGLE_CLIENT_ID` | Client ID for the project on google oauth |
### Development
1. Install packages
`yarn run install`
2. Start development server
`yarn run start`
## Deployment
The application is currently deployed using Heroku. To setup heroku, follow [this link](https://devcenter.heroku.com/articles/git#creating-a-heroku-remote) for further details.
Once setup, you will need to manually push to the heroku remote.
``` bash
git push heroku main
```