Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luzefiru/java-todo-app
A simple Todo App system in compliance with my 2106 class.
https://github.com/luzefiru/java-todo-app
Last synced: 5 days ago
JSON representation
A simple Todo App system in compliance with my 2106 class.
- Host: GitHub
- URL: https://github.com/luzefiru/java-todo-app
- Owner: Luzefiru
- License: mit
- Created: 2024-01-16T06:28:43.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-01-22T03:33:30.000Z (10 months ago)
- Last Synced: 2024-04-12T06:19:18.859Z (7 months ago)
- Language: JavaScript
- Size: 39.4 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# java-todo-app
A simple Todo App system with CRUD functionalities.
## Usage
First, we install the `npm` packages of the frontend:
```bash
git clone [email protected]:Luzefiru/java-todo-app.git
cd java-todo-app
cd client && npm i && cd ..
```
### Frontend Client
On one terminal, you need to run the browser application using the following commands:
> Ensure you have the [npm](https://nodejs.org/en/download) command available.
```bash
cd client
npm run dev
```
It will be accessible via `http://localhost:5173`.
### Database
This requires [XAMPP](https://www.apachefriends.org/download.html) to be running with a `todoapp` database.
1. In XAMPP, start Apache.
2. In XAMPP, start MySQL at port 3306 (default).
3. Create a `todoapp` database.
4. Click it & press the "Import" button at the navbar.
5. In the "File to import:" section, use the `server/todoapplication/TodoApplication/src/main/java/SQL File/task.sql` file.
6. Click "Import".
#### Alternative: Docker
> NOTE: Only use this if you don't want to do the XAMPP setup above!
First, you need to download & setup [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/).
```bash
cd server
docker compose up
```
### Backend Server
In an IDE, run the `server/todoapplication/TodoApplication/src/main/java/TodoApplication.java` program's `main` class.
> Ensure you are running the newest version of the [Java Runtime](https://www.java.com/en/download/manual.jsp).
> NOTE: We've only tested it in VSCode & IntelliJ.
It will be accessible via `http://localhost:3000/api/todos`.
## Project Structure
```yaml
java-todo-app/
│
├── client/ # frontend code
│ └── README.md # client installation documentation
│
├── server/ # backend code
│ └── README.md # server API documentation
│
└── README.md # project documentation
```
### Project Architecture
The React frontend hosted at `http://localhost:5173` uses HTTP calls to a Java Spring Boot backend at `http://localhost:3000/api/todos`. The backend is a REST API which responds in `Content-Type: application/json` which the frontend consumes.
## Contributing
Watch [How To Pull Request in 3 Minutes on YouTube](https://www.youtube.com/watch?v=jRLGobWwA3Y) to contribute and make a pull request.
## License
[MIT](https://choosealicense.com/licenses/mit/)