Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/faizan35/2-tier-todo-app-node-mysql
TodoApp is a minimalist two-tier web application, featuring a clean HTML, CSS, and JavaScript frontend for user interaction, and a Node.js backend with MySQL integration for task management and persistence.
https://github.com/faizan35/2-tier-todo-app-node-mysql
Last synced: about 1 month ago
JSON representation
TodoApp is a minimalist two-tier web application, featuring a clean HTML, CSS, and JavaScript frontend for user interaction, and a Node.js backend with MySQL integration for task management and persistence.
- Host: GitHub
- URL: https://github.com/faizan35/2-tier-todo-app-node-mysql
- Owner: faizan35
- License: mit
- Created: 2023-11-23T13:19:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-04T09:28:09.000Z (12 months ago)
- Last Synced: 2024-01-04T17:32:15.230Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Todo App
This is a simple two-tier todo application with a frontend built using HTML, CSS, and JavaScript, and a backend using Node.js, Express, and MySQL.
## Getting Started
### Prerequisites
- Node.js installed
- MySQL server installed and running
### Installation - Local Setup
1. Clone the repository:
```bash
git clone https://github.com/faizan35/2-tier-todo-app-node-mysql.git
```
```bash
cd 2-tier-todo-app-node-mysql
```
2. Install dependencies:
```bash
npm install
```
3. Set up the MySQL database:
- Create a database named `todo_app`.
- Run the SQL script in `database\tasks.sql` to create the `tasks` table.
4. Create a `.env` file in the project dir.
```bash
touch .env
```
5. Open the .env file and add your MySQL configuration:
```bash
MYSQL_HOST=mysql
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password
MYSQL_DB=your_database
```
### Usage
1. Start the Node.js server:
```bash
node backend/server.js
```
2. Open your browser and go to [http://localhost:3000](http://localhost:3000) to access the todo app.
---
### Installation - Docker
1. Open your root dir of the project
```bash
cd 2-tier-todo-app-node-mysql
```
2. Install docker and docker-compose
```bash
sudo apt install docker.io -y
```
```bash
sudo apt install docker-compose -y
```
3. Add docker to group
4. docker build -t todo_app .
5. docker-compose up -d
---
## Features
- Add tasks
- Fetch tasks from the MySQL database
- Delete task **<--- In progress --->**
## Contributing
Feel free to contribute to this project. Fork the repository, make your changes, and submit a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.