w3lcome-test

Project made to test the developer's fullstack job at W3LCOME

_{ToDo List W3LCOME. Built with ❤︎ by
wfTom}

About | Technologies | Features | How to run | License

🔖 About

The ToDo List W3LCOME is a Web and Server application of a List of ToDo activities, in this application is possibible create a new task, mark it as completed and delete it, the application also has paging, it also has an optimistic interface for updating and deleting. The log of all activities was implemented on the server with winston, which contains an info file and an error generated in the root of the server folder with all requests, timestamp and data of requests. It also has a health check endpoint in http://localhost:3333/healthcheck, generated by the express-healthcheck module. The swagger was configured to do the api documentation, which has 4 endpoints:

GET - to list the tasks, which also has the offset and limit parameters, to perform pagination
POST - to register a new task
PATCH - to mark a task as completed
DELETE - to delete a task.

Web Screenshot

💻 Technologies

This project was made using the follow technologies:

🚀 Features

ToDo list.
Add and Remove activities.
Pagination.
Mark as complete.
Requirements
- It is necessary to have Node.js installed on the computer.
- It is optional to have Git installed and configured on the computer, but it is better to have.
- Also, it is necessary to have a package manager be the NPM or Yarn.

# Clone Repository
$ git clone https://github.com/wfTom/w3lcome-test.git

📦 Run API

# Go to server folder
$ cd w3lcome-test/server

# Install Dependencies
$ yarn install

# Run Application
$ yarn dev

Access API at http://localhost:3333/

💻 Run Web Project

# Go to web folder
$ cd w3lcome-test/client

# Install Dependencies
$ yarn install

# Run Application
$ yarn dev

Go to http://localhost:3000/ to see the result.

📕 License

Released in 2021 📕 License

Made with love by wfTom 🚀. This project is under the MIT license.

Give a ⭐️ if this project helped you!

wfTom/w3lcome-test