https://github.com/shinchven/bootcamp
A Web Console Scaffolding. [FeathersJS/Ant Design Pro]
https://github.com/shinchven/bootcamp
antd featherjs webapp
Last synced: 9 months ago
JSON representation
A Web Console Scaffolding. [FeathersJS/Ant Design Pro]
- Host: GitHub
- URL: https://github.com/shinchven/bootcamp
- Owner: ShinChven
- Created: 2020-09-02T01:31:14.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-08T07:53:56.000Z (about 5 years ago)
- Last Synced: 2025-08-19T16:22:54.035Z (10 months ago)
- Topics: antd, featherjs, webapp
- Language: TypeScript
- Homepage:
- Size: 402 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# Bootcamp
This is my own scaffolding for building TypeScript fullstack enterprise webapp.
It is made of a nodejs backend in server folder and a react web client in console folder.
I have done the basic setups, and I believe you can run this project straight forward after you configured database connection in `server/config/default.json`'.
To get your hands on this project, you should have basic knowledge of NodeJS, React and TypeScript.
## A FeathersJS Server
The backend server of this webapp is built upon [FeathersJS](https://feathersjs.com/), a framework for real-time applications and REST APIs.
Please read FeathersJS' guide and doc before you get hands on this project.
## An Ant Design Pro (V4) Console
The web client of this webapp is built upon [Ant Design Pro V4](https://pro.ant.design/index-cn/), an out-of-box UI solution for enterprise applications.
Please read Ant Design Pro's guide and doc before you get hands on this project.
## Database Configration
Assuming you have read FeathersJS' guide and doc. Before you run this webapp, please setup your database configuration in `server/config/default.json`, it uses MySQL by default.
## Users and Authentication
Users and authentication are both initiated at web client side and server site. Please setup your initial username(email) and password in `server/config/default.json`. User will be generated at first run.
This project uses [JSONWebToken, aka jwt,](https://jwt.io/) for authentication strategey.
## Run
### Server
Run in server folder
```bash
npm install # Install dependencies.
npm start # Run the server.
npm run dev # Optional, run the server in dev mode in which the app reloads on code change.
```
### Console
Run in console folder
```bash
npm install # Install dependencies.
npm start # Start developing the console, the server namespace will be assigned to localhost:3030.
```
## Deploy Console
Run in console folder
```bash
npm run build; # Build console for production into dist folder.
cp -r dist ../server/public/console # Place console dist to server's public folder for static serving.
```
After console is deployed, you should be able to visit it at `http://localhost:3030/console`.
## Login and try
After you started console development, web page shall popup automatically. If not, please visit `http://localhost:8000` in your browser manually.
Please see preconfigred username and password in `server/config/default.json`.