This project contains an implementation of one RESTful API, using the framework Spring Boot of language java. Is a simple application where a user can sign up, realize log in to receive an authentication token JWT (JSON Web Token) and register tasks to your account
- Frontend:
- Backend:
- Database:
- Tools
These instructions will get you up and running with a copy of the project on your local machine for testing, development, and learning purposes. Prerequisites:
-
Have installed all the tools and dependencies:
- Google Chrome / Microsoft Edge
- Postman: https://www.postman.com/downloads/
- Java JDK (version >= 17)
- Maven
- MySQL Workbench
- IDE
- IntelliJ IDEA, VScode, Eclipse
-
Step 1: Clone the repository:
$ git clone https://github.com/Guimathis/todosimple-api.git
-
Step 2 on linux: Enter the application.properties file:
$ vi todosimple-api\src\main\resources\application-dev.properties
-
Step 2 on Windows: Enter the application.properties file:
$ notepad todosimple-api\src\main\resources\application-dev.properties
or open in your preference IDE.
-
Step 2.1: Configure the database credentials according to your MySQL Server installation:
# Database config spring.datasource.url=jdbc:mysql://localhost:3306/todosimple?createDatabaseIfNotExist=true spring.datasource.username=YOUR_USERNAME spring.datasource.password=YOUR_PASSWORD
-
Step 2.2: Back to the root project directory:
$ cd todosimple-api\
-
Step 2.3: Initialize the Spring Boot application:
$ mvn clean install
-
step 2.3.1: Initalize the spring boot application using Maven:
$ mvn spring-boot:run
- API the api will be running on http://localhost:8080/
-
Step 3: Enter the application frontend after uploading the API
-
Step 3.1: Enter the project root folder:
$ cd todosimple-api\
-
Step 3.2: Open the index.html file directly or through the VsCode Live Server extension:
$ cd todosimple-api\view $ login.html
- Frontend will be running on http://127.0.0.1:5500/view/login.html if initiated with Live Server.