Skip to content

Commit 191c52b

Browse files
committed
prepare new readme file
1 parent 04d9df5 commit 191c52b

File tree

1 file changed

+1
-47
lines changed

1 file changed

+1
-47
lines changed

README.md

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1 @@
1-
# Express.js React.js Typescript boilerplate
2-
3-
## Description
4-
5-
This is an express and react starter repo built with create-react-app and expres.js .
6-
7-
## Folder structure
8-
9-
Source code for Server and Client placed at root directory. **server** folder is for web services and **client** folder is for UI source codes in development mode. For production mode, client is bundled and set in to client directory under the `build` folder, and the server is bundled and set in to server directory under the `build` folder.
10-
11-
## Getting Started
12-
13-
Make sure you have node installed in your machine.
14-
To clone this repo to your local machine run the following command.
15-
16-
```
17-
git clone https://github.com/nadavpodjarski/express-react-typescript-boilerplate.git <YOUR-PROJECT>
18-
```
19-
20-
</br>
21-
22-
### Installing
23-
24-
To setup, go to the project's root folder and run the following command,
25-
26-
```
27-
./setup.sh
28-
```
29-
30-
This will install all dependencies and will create .env file for server and client
31-
</br>
32-
33-
### Development
34-
35-
To start development mode, go to the project's root folder and run the following commands
36-
37-
```
38-
cd server
39-
40-
npm run dev
41-
```
42-
43-
This will start node express with nodemon and in parallel it will start react development server.
44-
Any code changes in server or client directories will be reflected after saving.
45-
</br>
46-
47-
### Enjoy
1+
## Postgres - Pgdmin4 - Express.js - React.js Boilerplate

0 commit comments

Comments
 (0)