Skip to content

Commit

Permalink
Adding README
Browse files Browse the repository at this point in the history
  • Loading branch information
RafaelSolVargas committed Nov 1, 2021
1 parent 39fa8de commit 1308539
Showing 1 changed file with 28 additions and 11 deletions.
39 changes: 28 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,40 @@
# MyTasks
A React application to users create their own tasks
An online application that allow users to store and manage their tasks.

### What is the purpose of this
After spending some hours learning about how to make a application in React, i took the challenge to upgrade the code used in the video (link down below).
- My first idea is to create a Rest API with NodeJS and Sequelize ORM to store in a Postgres DataBase the users of the application and their Tasks.
- The application will have a simple login and a OAuth2.0 login with Google API
## Application

### Technologies and libraries
### Usage
The application is already running in Heroku and are accepting users creation with basic authentication and the CRUD operations in Tasks.
Application available in: <https://my-tasks-front.herokuapp.com>

### Purpose
After spending some hours learning about how to make an application in React, i took the challenge to upgrade the code used in this video <https://www.youtube.com/watch?v=ErjWNvP6mko&ab_channel=FelipeRocha%E2%80%A2dicasparadevs>.
- My first idea was to create a Rest API with NodeJS in the BackEnd to store data in an DataBase the users of the application and their Tasks.
- The application will have a simple authentication flow with email and password.
- For future upgrades some features could be implemented.

### Technologies, libraries and tools
- React
- JavaScript
- NodeJS
- PostgreSQL
- Sequelize
- OAuth 2.0
- Heroku

## Contributions
PR are welcome, for this you can clone this repository to your machine and work in some upgrade, (for example one of the following). Then request a PR so we could talk about your implementation.

### Future Features
- OAuth 2.0 with Google/Facebook.
- Users Settings to control name and change password.
- Users preferences for application colors.
- Reset password with Nodemailer.


### What you can see
- All the codes will be mostly commented and explained to anyone that want to know how to do an Rest API
- The major focus and explanation in this repository will stand in the backend development
- All the codes will be mostly commented and explained to anyone that want to know how to do an Rest API.
- The major focus and explanation in this repository will stand in the backend development.

## License

[MIT](https://choosealicense.com/licenses/mit/)

Inspiration Youtube Video --> https://www.youtube.com/watch?v=ErjWNvP6mko&ab_channel=FelipeRocha%E2%80%A2dicasparadevs

0 comments on commit 1308539

Please sign in to comment.