Skip to content

Commit

Permalink
📝 Updated read me backend
Browse files Browse the repository at this point in the history
  • Loading branch information
dennism501 committed Aug 10, 2021
1 parent d9ef77c commit b211137
Show file tree
Hide file tree
Showing 7 changed files with 52 additions and 279 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# To Do

This web application is a simple application to manage a list of things to do.

## Features ✨

The application has few main features:

1. Create a todo
2. Create a todo with a due due date
3. Filter the to do list by the current date.

## Infrastructure

This applications consists of two parts:
1. Frontend: Single Page Application built with: React and Material.
2. Backend: HTTP REST API built with Node.js, Express and MongoDB.

1. Frontend: Single Page Application built with: React and Material.
2. Backend: HTTP REST API built with Node.js, Express and MongoDB.

## How to run

Expand All @@ -18,3 +28,15 @@ once the app is running you can open:
http://localhost:3000

on your browser.

## Future works

Provided more time, there are a few things are need improving.

1. Complete the implementation of the auto scroll on the frontend, the backend has an implementation on pagination using the `{page, pageSize}` method to load the todos and a default of 20 records on each request.
2. Add more tests and fixing the failing tests on both the frontend and the backend.
3. More error handling on the frontend when the user enters a numeric value. The backend doesn't accept numeric values but the frontend doesn't not display that correctly.
4. Add version Control.
5. Again, add more tests!!

## Enjoy! 🚀
27 changes: 27 additions & 0 deletions frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@
"eslint-plugin-react": "7.24.0",
"eslint-plugin-react-hooks": "4.2.0"
}
}
}
168 changes: 0 additions & 168 deletions frontend/src/Todos.js

This file was deleted.

67 changes: 0 additions & 67 deletions frontend/src/components/TodoItem.js

This file was deleted.

29 changes: 0 additions & 29 deletions frontend/src/components/TodoList.js

This file was deleted.

12 changes: 0 additions & 12 deletions frontend/src/index.js

This file was deleted.

0 comments on commit b211137

Please sign in to comment.