To Do Application - Simple

Overview

🚀 This is a production ready and complete solution. It can be modified for your needs and deployed in the environment of your choice.

🎓 Perfect for learning the fundamentals of API AutoFlow.

Single page application with basic read and write to database.

A more advanced versions of To Do, Task management, and Work Collaboration applications are also available.

More features will be added to the project in the future.

The UI of this project was inspired by this amazing Radon333's work on todo-app.

Installation and usage

The easiest way is to clone the entire application from the cloud marketplace. But, feel free to customize the application by running it on your local computer.

Running on the Cloud

Follow the instructions on the cloud marketplace listing to clone the application (instance) to your account.

Running on the Local Computer

To run it locally to customize the application, please follow below instructions.

Download

Clone this repository :

git clone https://github.com/API-AutoFlow/To-Do-Basic.git

Frontend

Install & Run ReactJS Package:

cd frontend
npm install   
npm run dev 

Backend

Install & Run API AutoFlow packages :

► MAC: (press to expand)

cd backend/macos/api_interactor/bin
./api_interactor start 

Open up the browser and go to below URL

http://localhost:4000

🚨 IMPORTANT: Run the servers by pressing the ▶️ button

Reference: http://www.interactor.com/product/autoflow/installation/macos

► Windows: (press to expand)

🚨 IMPORTANT: Open the terminal (cmd) using Run as Administrator

cd /backend/windows/api_interactor/bin
./api_interactor install 
./api_interactor start 

Open up the browser and go to below URL

http://localhost:4000

🚨 IMPORTANT 🚨 Run the servers by pressing the ▶️ button

Reference: http://www.interactor.com/product/autoflow/installation/windows

► Linux: (press to expand)

Step 1: Download the linux version www.interactor.com/product/autoflow/download

Step 2: Open the terminal after downloading the software and Untar the file. For example:

tar -xzf autoflow_ubuntu20.tar

Step 3: Run API AutoFlow command

cd home/api_interactor/bin
./api_interactor start 

Step 4: Open up the browser and go to below URL

http://localhost:4000

Step 4: Run the servers by pressing the ▶️ button

Reference: http://www.interactor.com/product/autoflow/installation/linux

Database

Unfortunately, there's no easy way to just clone the entire database.

You first need to install the database in your computer and follow the instructions below to dump the data to your newly installed database.

Install MySQL:
https://dev.mysql.com/doc/mysql-installation-excerpt/8.0/en/

Install Workbench:
https://dev.mysql.com/downloads/workbench/

Import data to data:
https://dev.mysql.com/doc/workbench/en/wb-admin-export-import-management.html

🚨 IMPORTANT: Use the file dump.sql to import into your database

Props

API Endpoints

No.	Name	Type	Endpoint	Description
1	Create	POST	/	Creates the task
2	Read	GET	/	Reads the task
3	Update	PATCH	/	Updates the task
4	Delect	DELETE	/	Deletes the task

1. Create : POST /

Request:

{aas}

Response:

{aas}

2. Read : GET /

Request:

{aas}

Response:

{aas}

3. Update : PATCH /

Request:

{aas}

Response:

{aas}

4. Delete : DELETE /

Request:

{aas}

Response:

{aas}

Database Tables

task:

id	title	due	status

Scaling the solution

• How to deploy in Kubernetes

Star, Fork, Clone & Contribute

Feel free to contribute on this repository. If my work helps you, please give me back with a star. This means a lot to me and keeps me going!