Skip to content

Commit

Permalink
Update README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
Hsins committed Jul 4, 2019
1 parent 098dc90 commit ba9e969
Show file tree
Hide file tree
Showing 2 changed files with 96 additions and 1 deletion.
97 changes: 96 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,96 @@
# udemy_Todo-List
<div align="right">
<img src="https://img.shields.io/badge/Completion-100%25-blue.svg" />
<a href="https://github.com/Hsins/udemy_MERN-Todo-List/blob/master/LICENSE" alt="License">
<img src="https://img.shields.io/github/license/Hsins/udemy_MERN-Todo-List.svg" />
</a>
</div>

# Udemy Project: MERN Todo-List

This is a hands-on project from the Udemy course - [The Advanced Web Developer Bootcamp](https://www.udemy.com/the-advanced-web-developer-bootcamp/) by Colt Steele. Refactored using the React-Redux in ES6/ES7 syntax instead of jQuery. You can find this jQuery version [here](https://github.com/Hsins/udemy_jQuery-Todo-List).

# Demo

<div align="center">
<img src="demo/demo.gif" />
</div>

You can see a complete working example [here](https://hsins-mern-todolist.herokuapp.com/). Or you can run the demo on your local machine, please follow the instructions in [Getting Started](#getting-started).

# Features

- A MERN (MongoDB + Express.js + React.js + Node.js) full stack project.
- RESTful API:
```
-------------------------------------------------------------------------
Todos Route
-------------------------------------------------------------------------
[Method] [Route]
GET /api/todos Fetch all todos
POST /api/todos Create a new todo
GET /api/todos/:id Fetch a todo status
POST /api/todos/:id Toggle (complete or not) a task
PATCH /api/todos/:id Update the todo content
DELETE /api/todos/:id Delete todo
```
- Refactored with ES6 and ES7 syntax (eg: async/await)

# Technologies

## Frontend

- [axios](https://github.com/axios/axios)
- [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware)
- [React](https://reactjs.org/)
- [Redux](https://redux.js.org/)
- [Redux-Thunk](https://github.com/reduxjs/redux-thunk)

## Backend

- [nodejs](https://nodejs.org/en/)
- [express](https://gulpjs.com/)
- [mongodb](https://webpack.js.org/concepts/)

Check [`package.json`](https://github.com/Hsins/udemy_MERN-Todo-List/blob/master/package.json) file for more information.

# Getting Started

Follow the instructions below to set up the environment and run this project on your local machine. Note that you should setup your MongoDB Atlas Cluster first to get your database. You can find the [Quick Note](https://hackmd.io/@Hsins/r1oFNI864) here.

1. Clone this repository.

```bash
# Clone repository
$ git clone https://github.com/Hsins/udemy_MERN-Todo-List.git
```

2. Install dependencies via NPM or Yarn

```bash
# Install dependencies via npm
$ npm install
$ cd client
$ npm install
$ cd ..

# Install dependencies via yarn
$ yarn install
$ cd client
$ yarn install
$ cd ..
```

3. Run the server.

```bash
# Run server
$ npm run dev
```

# More Information

All the notes I took in [Markdown](https://daringfireball.net/projects/markdown/syntax) (.md) format. You can find them in my [Udemy-Notes](https://github.com/Hsins/Udemy-Notes) repository. The note for this course is [here](https://hsins.github.io/Udemy-Notes/The%20Advanced%20Web%20Developer%20Bootcamp/).

# License

Licensed under the MIT License, Copyright © 2017-present Hsins.
Binary file added demo/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ba9e969

Please sign in to comment.