{"id":26210134,"url":"https://github.com/zerlock/epytodo","last_synced_at":"2025-04-15T13:49:03.799Z","repository":{"id":38384480,"uuid":"456465233","full_name":"ZerLock/Epytodo","owner":"ZerLock","description":"Epytodo","archived":false,"fork":false,"pushed_at":"2022-06-05T13:47:28.000Z","size":72,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T20:45:54.799Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/ZerLock/epytodo_front","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ZerLock.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-07T10:50:23.000Z","updated_at":"2023-07-05T14:13:35.000Z","dependencies_parsed_at":"2022-08-25T06:01:16.820Z","dependency_job_id":null,"html_url":"https://github.com/ZerLock/Epytodo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZerLock%2FEpytodo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZerLock%2FEpytodo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZerLock%2FEpytodo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ZerLock%2FEpytodo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ZerLock","download_url":"https://codeload.github.com/ZerLock/Epytodo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249084759,"owners_count":21210262,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-12T07:19:26.402Z","updated_at":"2025-04-15T13:49:03.781Z","avatar_url":"https://github.com/ZerLock.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Epytodo\n=======\n\n## Description\nEpytodo is a first year project at Epitech in which we have to create our own web API. This API aims to manage a database to store users and tasks that they can create, modify and delete. This method of tasks is very common in the professional world in order to organise on a solo or team project.\n\nHere is the recommended repository's structure used for this project (without bonuses) :\n\n![Repository's Structure](./assets/repository_structure.png)\n\n## Install and Run the project\n### Requirements\n\u003e - [NodeJS](https://nodejs.org/en/download/package-manager/)\n\u003e - [MySQL](https://dev.mysql.com/doc/mysql-installation-excerpt/5.7/en/) or [MariaDB](https://www.mariadbtutorial.com/getting-started/install-mariadb/)\n\u003e - [PhpMyAdmin](https://docs.phpmyadmin.net/en/latest/setup.html) (optional, if you want to view your database)\n\n---\n\nTo use the EpyTodo, you need to install the dependencies and launch it locally on your PC.\n\n*Clone the project:*\n```\ngit clone git@github.com:ZerLock/Epytodo.git\n\ncd EpyTodo\n```\n\n*Install all dependencies:*\n```\nnpm install\n```\n\n*Create the database:*\n```\ncat epytodo.sql | mysql -u root -p\n```\n\n*Run the project:*\n```\nnpm start\n```\n\nEnjoy !\n\n---\n\n## Specifications\n- In the environment variables, we use **MYSQL_PASSWORD** and not **MYSQL_ROOT_PASSWORD**. We wanted to do it as if it were a customer service. So each project has a different login which is not **ROOT** !\n\n- A regex.js file has been added in /src/config allowing us to have and use the regex globally in the project!\n\n- If the user does not specify the **PORT** in the environment variables or the port is already taken. The application will launch on port 3000.\n\n- The **routes** are named like those in the table on page 4 of the 2026 promo topic.\n \n## EpyTodo instructions routes\nIn order to take full advantage of this project. It is important to know each of the routes and their use within the API.\n\n|Route              |Method|Protected|Description|\n|:------------------|:-----|:--------|:----------|\n|/register          |POST  |NO       |Register a new user|\n|/login             |POST  |NO       |Connect a user|\n|/user              |GET   |YES      |View all user information|\n|/user/todos        |GET   |YES      |View all user tasks|\n|/users/:id or :email|GET   |YES      |View user information|\n|/users/:id          |PUT   |YES      |Update user information|\n|/users/:id          |DELETE|YES      |Delete user|\n|/todos              |GET   |YES      |View all the todo|\n|/todos/:id          |GET   |YES      |View the todo|\n|/todos              |POST  |YES      |Create a todo|\n|/todos/:id          |PUT   |YES      |Update a todo|\n|/todos/:id          |DELETE|YES      |Delete a todo|\n\\* To access the protected routes, you need a token that can be retrieved via the ``/register`` and ``/login`` routes.\u003cbr\u003e\n\\** todo = task\n\n## Results\n|Label|Mark|\n|:---:|:--:|\n|Preliminaries|2/2|\n|Web Server|5/5|\n|Routes (does it exists)|3/3|\n|Routes (Is it well done)|3/3|\n|Password|1/1|\n|Token|3/3|\n|SQL DB|5/5|\n\n## Bonuses\n\nWe have several bonuses like, a **Postman collection**, an accessible **frontend** (on a version dating from 3 days before the rendering of the project) on [epuytodo.tk](https://epuytodo.tk) (code available on [github.com/ZerLock/epytodo_front](https://github.com/ZerLock/epytodo_front) )\n\n---\n\n## Developers\n- [Léo Dubosclard](https://www.github.com/ZerLock)\n- [Baptiste Leroyer](https://github.com/ZiplEix)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzerlock%2Fepytodo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzerlock%2Fepytodo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzerlock%2Fepytodo/lists"}