Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marcusvbrangel/ignite-defafio-conceitos-do-node

This is an application to manage tasks. It will be allowed to create a user with name and username, as well as CRUD tasks.
https://github.com/marcusvbrangel/ignite-defafio-conceitos-do-node

cors express jest nodejs nodemon supertest uuid

Last synced: 1 day ago
JSON representation

This is an application to manage tasks. It will be allowed to create a user with name and username, as well as CRUD tasks.

Awesome Lists containing this project

README

        

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)

# Ignite Node - Node.js concepts

## About :cyclone:

#### This is an application to manage tasks. It will be allowed to create a user with name and username, as well as CRUD tasks.

## requirements :cyclone:

- [ x ] Create a new todo.
- [ x ] List all todos.
- [ x ] Update the title and deadline of an existing todo.
- [ x ] Mark a todo as done.
- [ x ] Delete a todo.

## Tests :cyclone:

- [ x ] Should be able to list all user's todos.
- [ x ] Should be able to create a new todo.
- [ x ] Should be able to update a todo.
- [ x ] Should not be able to update a non existing todo.
- [ x ] Should be able to mark a todo as done.
- [ x ] Should be able to delete a todo.
- [ x ] Should not be able to delete a non existing todo.

## Application routes :cyclone:

* POST /users
* GET /todos
* POST /todos
* PUT /todos/:id
* PATCH /todos/:id/done
* DELETE /todos/:id


## Prerequisites :cyclone:

Make sure you have installed all of the following prerequisites on your development machine:

* Git - [Download & Install Git](https://git-scm.com/downloads/). OSX and Linux machines typically have this already installed.
* Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.

## Dependency libraries :cyclone:

* cors
* express
* uuid
* jest
* nodemon
* supertest


## Getting Started :cyclone:

1. Clone this repository

```sh
git clone https://github.com/marcusvbrangel/ignite-defafio-conceitos-do-node.git
```

2. Install the dependencies

```sh
npm install
```

3. Start the app

```sh
npm run dev
```



## Contributing :cyclone:

Have a look through existing [Issues](https://github.com/marcusvbrangel/ignite-defafio-conceitos-do-node/issues) and [Pull Requests](https://github.com/marcusvbrangel/ignite-defafio-conceitos-do-node/pulls) that you could help with.


If this is your first time contributing to this project, please do read our [Contributor Workflow Guide](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md) before you get started off.

Feel free to open issues and pull requests. We're always welcome support from the community.


## Code of Conduct :cyclone:

Help me keep this project open and inclusive. Please read and follow our [
of Conduct](https://github.com/the-guild-org/Stack/blob/master/CODE_OF_CONDUCT.md) as adopted from [Contributor Covenant](https://www.contributor-covenant.org/)


## Acknowledgments :cyclone:

[Rocketseat](https://www.rocketseat.com.br/)


## Contact :cyclone:

* Email: [email protected]
* GitHub: https://github.com/marcusvbrangel/
* Twitter: https://twitter.com/marcusvbrangel/
* LinkedIn: https://www.linkedin.com/in/marcusrangel/


## License :cyclone:

Copyright (c) Marcus Rangel. All rights reserved.

Licensed under the [MIT](LICENSE) license.