README.md 543 Bytes
Newer Older
Sam Galson's avatar
Sam Galson committed
1 2 3 4 5 6
# PubSweet App

Welcome to the skeleton application!

## Quickstart

Sam Galson's avatar
Sam Galson committed
7
```bash
8
pubsweet start   # or npm start
Sam Galson's avatar
Sam Galson committed
9
```
Sam Galson's avatar
Sam Galson committed
10

11 12 13
This will use Docker to get you up and running quickly. See `pubsweet` docs for
troubleshooting and other ways to start the app.

Sam Galson's avatar
Sam Galson committed
14 15
## Customising the skeleton application

Tamlyn Rhodes's avatar
Tamlyn Rhodes committed
16 17
* Change `name` in `package.json` to your desired name
* Modify app config in the `/config` directory and webpack config in `/webpack`.
18 19
* Run `pubsweet add <components>` or `pubsweet remove <components>` to add or
  remove components.
Tamlyn Rhodes's avatar
Tamlyn Rhodes committed
20
* Rewrite this README!