Skip to content

Commit 38e13e9

Browse files
committed
Readme updates
1 parent 1876d82 commit 38e13e9

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

README.md

+24-14
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@ This project uses the MariaDB Node.js connector in combination with the [Sequeli
1010
</kbd>
1111
</p>
1212

13+
This application is made of two parts:
14+
15+
* Client
16+
- web UI that communicates with REST endpoints available through an API app (see below).
17+
- is a React.js project located in the [client](src/client) folder.
18+
* API
19+
- uses the [MariaDB Node.js Connector](https://github.com/mariadb-corporation/mariadb-connector-nodejs) with [Sequelize](https://sequelize.org/) to connect to MariaDB.
20+
- is a Node.js project located int the [api](src/api) folder.
21+
1322
This README will walk you through the steps for getting the TODO web application up and running using MariaDB.
1423

1524
# Table of Contents
@@ -19,7 +28,8 @@ This README will walk you through the steps for getting the TODO web application
1928
4. [Create the database and table](#schema)
2029
5. [Configure, build and run the app](#app)
2130
1. [Configure](#configure-app)
22-
2. [Build and run](#build-run)
31+
2. [Build and run the API app](#build-run-api)
32+
3. [Build and run the Client app](#build-run-client)
2333
6. [Support and contribution](#support-contribution)
2434
7. [License](#license)
2535

@@ -82,10 +92,10 @@ CREATE TABLE todo.tasks (
8292
This application is made of two parts:
8393

8494
* Client
85-
- communicates with the API.
95+
- web UI that communicates with REST endpoints available through an API app (see below).
8696
- is a React.js project located in the [client](src/client) folder.
8797
* API
88-
- uses the [MariaDB Node.js Connector](https://github.com/mariadb-corporation/mariadb-connector-nodejs) to connect to MariaDB.
98+
- uses the [MariaDB Node.js Connector](https://github.com/mariadb-corporation/mariadb-connector-nodejs) with [Sequelize](https://sequelize.org/) to connect to MariaDB.
8999
- is a Node.js project located int the [api](src/api) folder.
90100

91101
### a.) Configure the app <a name="configure-app"></a>
@@ -144,27 +154,27 @@ const sequelize = new Sequelize(process.env.DB_NAME, process.env.DB_USER, proces
144154
});
145155
```
146156

147-
### b.) Build and run the app <a name="build-run-app"></a>
157+
### b.) Build and run the app <a name="build-run-api"></a>
148158

149-
Within separate terminal windows perform the following steps:
159+
To start and run the API application you need to execute the following commands within the [root folder](src/api).
150160

151-
1. Install the Node.js packages (dependendies) for the [client](src/client) and [api](src/api) apps using the `npm install` command.
161+
1. Install the Node.js packages (dependendies) for the app.
152162

153-
_For example:_
154163
```bash
155-
$ npm install ./src/client
156-
$ npm install ./src/api
164+
$ npm install
157165
```
158166

159-
2. Run the [client](src/client) and [api](src/api) apps using the `npm start` command.
167+
2. Run the the app, which will expose API endpoints via http://localhost:8080.
160168

161-
_For example:_
162169
```bash
163-
$ npm start --prefix ./src/api
164-
$ npm start --prefix ./src/client
170+
$ npm start
165171
```
166172

167-
**Note:** You will need to use seperate terminals for the `client` and `api` apps.
173+
### c.) Build and run the [UI (Client) app](src/client) <a name="build-run-client"></a>
174+
175+
Once the API project is running you can now communicate with the exposed endpoints directly (via HTTP requests) or with the application UI, which is contained with the [client](src/client) folder of this repo.
176+
177+
To start the [client](src/client) application follow the instructions [here](https://github.com/mariadb-developers/todo-app-client).
168178

169179
## Support and Contribution <a name="support-contribution"></a>
170180

0 commit comments

Comments
 (0)