Alamantus
/
Readlebee
mirror of https://gitlab.com/Alamantus/Readlebee.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README to reflect addition of image processing

This commit is contained in:
Robbie Antenesse 2019-09-06 23:22:08 -06:00
parent f29e445998
commit 0f287748c1
1 changed files with 3 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -45,7 +45,8 @@ Alternatively, you can use the NPM that's included with Node:
npm install npm install
``` ```
This install process will compile the sass into CSS at `public/css/index.css` after the dependencies are installed. This install process will compile the sass into CSS at `public/css/index.css` and turn the svg in `images`
into PNGs in `public/images` after the dependencies are installed. (Note: This runs even if you install new packages.)
In the future, this postinstall process will also set up the database tables. In the future, this postinstall process will also set up the database tables.
## Usage ## Usage
@ -56,13 +57,6 @@ After everything's installed, run the "start" NPM script to build and serve the
npm start npm start
``` ```
Included in the `start` process is the sass compilation process again, so if you'd like to skip that process each time
you start the server, you can instead use the `start-server` process like this:
```
npm run start-server
```
Then use your browser to navigate to http://localhost:1234 to view the website. Then use your browser to navigate to http://localhost:1234 to view the website.
When you make a change, you need to stop the server with `Ctrl+C` and re-run the script. When you make a change, you need to stop the server with `Ctrl+C` and re-run the script.
@ -165,7 +159,7 @@ and do any other things that need to be done to get the project set up and usabl
Run the following to start the server: Run the following to start the server:
``` ```
sudo npm start sudo npm start-production
``` ```
Then it'll be running on your server's localhost at the port you specified in the config! Then it'll be running on your server's localhost at the port you specified in the config!