Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nionata committed May 21, 2020
1 parent 3530d86 commit ce5d6d4
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

### `/`

- #### `client/`
[Client](/client#client) is the frontend of the application. It is powered by [React](https://reactjs.org/) and [Blockly](https://developers.google.com/blockly).
#### `client/`
[Client](/client#client) is the frontend of the application. It is powered by [React](https://reactjs.org/) and [Blockly](https://developers.google.com/blockly).

#### `cms/`

Expand Down
2 changes: 1 addition & 1 deletion client/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Client

[React.js](https://reactjs.org/) application which represents the entire browserside client. File structure is standard for a [create-react-app](https://github.com/facebook/create-react-app) application with some minor changes. Any component which represents an entire page is categorized under the [views](/client/src/views) folder.
> [React.js](https://reactjs.org/) application which represents the entire browser-side client. File structure is standard for a [create-react-app](https://github.com/facebook/create-react-app) application with some minor changes. Any component which represents an entire page is categorized under the [views](/client/src/views) folder.
<br />

Expand Down
35 changes: 33 additions & 2 deletions cms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,44 @@ REST API and admin portal that comprise the backend. It is powered by [Node](htt
### Development

1. Install [docker](https://docs.docker.com/get-docker/)
3. Start a new docker container running postgres `yarn run make-db`
3. Start a new docker container running postgres `yarn run db-make`
4. Install dependencies `yarn install`
5. Start the development server `yarn develop`

Additional scripts:

* Start an existing db container `yarn db-start`
* Connect to the postgres bash `yarn db-bash`
* Build and add the client `yarn build-frontend`

<br/>

## Static Assets

All assets in the **public** directory will be served. The specifics are defined [here](https://strapi.io/documentation/3.0.0-beta.x/concepts/public-assets.html).

### Frontend

The frontend (**public/frontend**) is served this way with a slight twist. Due to the way public assets are natively served in Strapi, a frontend middleware handles serving **frontend/index.html**. The other frontend assets are served natively. If the middleware was not implemented, pasting a non-root frontend path would lead to a 404. Read more about this [here](https://github.com/STEM-C/STEM-C/pull/28#pullrequestreview-415846251).

> As routes are added to react router, they will need to be added to the config
```json
// middlewares/frontend/defaults.json

{
"frontend": {
...
"routes": [
"/",
"/login",
"/register",
"/teacher*",
"/workspace*"
]
}
}
```

<br/>

Expand Down Expand Up @@ -67,4 +97,5 @@ Read the full [documentation](https://strapi.io/documentation/3.0.0-beta.x/conte

Built with [React](https://reactjs.org/) and served by [Node](https://nodejs.org/en/), the admin panel allows for full customization of the server. Here you can create new content types and their corresponding endpoints, configure roles and permissions, and much more. The interface itself can be customized and configured as needed.

Read the full [documentation](https://strapi.io/documentation/3.0.0-beta.x/admin-panel/customization.html) on the admin panel.
Read the full [documentation](https://strapi.io/documentation/3.0.0-beta.x/admin-panel/customization.html) on the admin panel.

0 comments on commit ce5d6d4

Please sign in to comment.