Update README.md
This commit is contained in:
parent
766dcdec3a
commit
91b9dcf22d
42
README.md
42
README.md
@ -0,0 +1,42 @@
|
|||||||
|
|
||||||
|
# Eduvos Books
|
||||||
|
|
||||||
|
A simple web app allowing users to download PDF books for their subjects.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Note
|
||||||
|
|
||||||
|
No textbooks are included in this git repo. All books are stored in the folder `files`, seperated into subfolders for each subject.
|
||||||
|
|
||||||
|
|
||||||
|
## Setup and installation
|
||||||
|
|
||||||
|
NodeJS and NPM are required (NPM should be packaged with standard NodeJS install)
|
||||||
|
[https://nodejs.org/en]
|
||||||
|
|
||||||
|
Clone the project onto your local machine with
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.bttstudios.co.za/Thomas_Dev/Eduvos-Books.git
|
||||||
|
```
|
||||||
|
|
||||||
|
Install required project files with
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd {project_location}
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
Create your `files` location, and populate it with your files (can be within subfolders)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mkdir files
|
||||||
|
```
|
||||||
|
|
||||||
|
Launch the project by running
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node app.js
|
||||||
|
```
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user