This is an open source to-do applicaiton that enable users to create and manage their to-do's.
- Users can signup and login to their accounts
- Authenticated users can create, update, delete and get all their to-do's.
- Clone this repository here.
- The main branch is the most stable branch at any given time, ensure you're working from it.
- Run
php composer update && php composer installin the backend folder to install dependencies. - Provide database connection creds in backend .env file.
- Run
npm installin the frontend folder to install dependencies. - Provide api address in frontend .env under
VITE_API_URL
- Run
php artisan serverin backend folder to start the API. - Run
npm run devin frontend folder
- Run
docker-compose up --build -d; docker-compose logs -fto start the application.
| HTTP Verbs | Endpoints | Action | Body |
|---|---|---|---|
| POST | /api/auth/register | To sign up a new user account | name:string, email:string, password:string, c_password:string |
| POST | /api/auth/login | To login an existing user account | email:string, password:string, remember_me:boolean |
| GET | /api/auth/logout | To logout from the application | - |
| GET | /api/auth/user | To logout from the application | - |
| POST | /api/todos | To create a new to-do | title:string, content:string, page_id:number |
| GET | /api/todos | To retrieve all your to-do's | - |
| GET | /api/todos/:todoId | To retrieve certain to-do | - |
| GET | /api/todos/page/:pageId | To retrieve to-do's by page | - |
| PUT | /api/todos/:todoId | To edit the to-do | title:string, content:string, is_done:boolean |
| DELETE | /api/todos/:todoId | To delete a single to-do | - |
| POST | /api/pages | To create a new page | title:string, description:string |
| GET | /api/pages | To retrieve all your pages | - |
| GET | /api/pages/:pageId | To retrieve certain page | - |
| PUT | /api/pages/:pageId | To edit the page | title:string, description:string |
| DELETE | /api/pages/:pageId | To delete a single page | - |
- PHP A popular general-purpose scripting language that is especially suited to web development.
- Laravel Laravel is a free and open-source PHP-based web framework for building web applications.
- PostgreSQL A free and open-source relational database management system (RDBMS) emphasizing extensibility and SQL compliance.
- Docker Docker is an open platform for developing, shipping, and running applications. Docker provides the ability to package and run an application in a loosely isolated environment called a container.
- React React is the library for web and native user interfaces. Build user interfaces out of individual pieces called components written in JavaScript.
- Vite Vite is a blazing fast frontend build tool powering the next generation of web applications.
- Tailwind Tailwind CSS is a utility-first CSS framework for rapidly building modern websites without ever leaving your HTML.
- GSAP GSAP is an industry standard JavaScript animation library from GreenSock that lets you craft high-performance animations that work in every major browser.
- Three.js The aim of the project is to create an easy-to-use, lightweight, cross-browser, general-purpose 3D library. The current builds only include WebGL and WebGPU renderers but SVG and CSS3D renderers are also available as addons.
This project is available for use under the MIT License.