Skip to content

Commit 6dfb90a

Browse files
authored
update readme
1 parent 85d2a0f commit 6dfb90a

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

README.md

+16-18
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,29 @@
1-
# Adonis fullstack application
1+
# Adonis-React application
22

3-
This is the fullstack boilerplate for AdonisJs, it comes pre-configured with.
4-
5-
1. Bodyparser
6-
2. Session
7-
3. Authentication
8-
4. Web security middleware
9-
5. CORS
10-
6. Edge template engine
11-
7. Lucid ORM
12-
8. Migrations and seeds
3+
This is an unofficial boilerplate for [AdonisJs](https://adonisjs.com/) with a [ReactJS](https://reactjs.org/) frontend, built from the [official fullstack application boilerplate for Adonisjs](https://github.com/adonisjs/adonis-fullstack-app)
134

145
## Setup
156

16-
Use the adonis command to install the blueprint
7+
You can manually clone the repo and then run `npm install`, or you can do it the Adonis way:
8+
9+
First, install the cli tool globally:
1710

1811
```bash
19-
adonis new yardstick
12+
npm i -g @adonisjs/cli
2013
```
2114

22-
or manually clone the repo and then run `npm install`.
23-
15+
And then to create a project:
2416

25-
### Migrations
17+
```bash
18+
adonis new <name> --blueprint=MargotDem/adonis-react-app
19+
```
2620

27-
Run the following command to run startup migrations.
21+
#### Development:
22+
To start developing your app, do:
2823

2924
```js
30-
adonis migration:run
25+
cd <name>
26+
npm run dev
3127
```
28+
29+
This will concurrently serve your app on localhost:3333 and compile (and watch) the frontend assets

0 commit comments

Comments
 (0)