Skip to content

Commit 315844e

Browse files
author
hirsch88
committed
Upgrades the readme
1 parent 9def373 commit 315844e

File tree

2 files changed

+51
-21
lines changed

2 files changed

+51
-21
lines changed

README.md

Lines changed: 51 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,27 +40,57 @@ Try it!! We are happy to hear your feedback or any kind of new features.
4040
- **Integrated Testing Tool** thanks to [Wallaby.js](https://wallabyjs.com/)
4141

4242
## Getting Started
43-
### Prerequisites
44-
* Install [Node.js](http://nodejs.org)
45-
* on OSX use [homebrew](http://brew.sh) `brew install node`
46-
* on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`
47-
* Install yarn globally `npm install yarn -g`
48-
49-
### Installing
50-
* `fork` this repo
51-
* `clone` your fork
52-
* `cp .env.example .env` to copy the example .env file and enter your database connection
53-
* Create a new database. You will find the name in the .env file.
54-
* Run `npm run setup` or enter the following commands manually:
55-
* `yarn install` to install all dependencies and typings.
56-
* `npm run db:migrate` to create the schema.
57-
* `npm run db:seed` to insert some test data.
58-
* `npm run serve` to start the application.
59-
60-
### Running the app
61-
After you have installed all dependencies you can run the app.
62-
Enter `npm run serve` to start a local server using `nodemon`, which will watch for any file changes and will restart the sever according to these changes.
63-
The server address will be displayed to you as `http://0.0.0.0:3000`.
43+
### Step 1: Set up the Development Environment
44+
You need to set up your development environment before you can do anything.
45+
46+
Install [Node.js and NPM](https://nodejs.org/en/download/)
47+
* on OSX use [homebrew](http://brew.sh) `brew install node`
48+
* on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`
49+
50+
Install yarn globally
51+
```npm install yarn -g```
52+
53+
Install a MySQL database.
54+
55+
> If you work with a mac, we recommend to use homebrew for the installation
56+
57+
#### Step 2: Create new Project
58+
Fork or download this project. Configure your package.json for your new project.
59+
60+
Then copy the example .env file and enter your database connection.
61+
62+
Create a new database. You will find the name in the .env file.
63+
64+
Then setup your application environment.
65+
```
66+
npm run setup
67+
```
68+
69+
> This installs all dependencies with yarn. After that it migrates the database and seeds some test data into it.
70+
71+
#### Step 3: Serve your App
72+
Go to the project dir and start your app
73+
```
74+
npm run serve
75+
```
76+
77+
> This starts a local server using `nodemon`, which will watch for any file changes and will restart the sever according to these changes.
78+
> The server address will be displayed to you as `http://0.0.0.0:3000`.
79+
80+
#### Step 4: Create a new Resource
81+
Go to the project dir and hit this command
82+
```
83+
npm run console make:resource
84+
```
85+
86+
Apply the same information like you see below in the screenshot.
87+
88+
![console](console.png)
89+
90+
> Now you have created a complete new endpoint in your api for the resource pets
91+
92+
#### Step 5: Create a Seeder
93+
TODO
6494

6595
## Scripts / Tasks
6696
All script are defined in the package.json file, but the most important ones are listed here.

console.png

126 KB
Loading

0 commit comments

Comments
 (0)