CloudCVfy Webapp
Follow issues template to file an issue unless it is a feature request.
Build instructions
This application requires node v5+
Using Docker:
- Install docker
- Install docker-compose
- Clone this repository
Note: Make sure the user deploying this application is in the "docker" group. That is, the user can use docker without sudo access.
sudo groupadd docker
sudo usermod -aG docker $USER
Then logout and log back in.
A.) docker compose (recommended)
docker-compose up -d
- Wait for the build to finish. Visit
0.0.0.0:5001
. Follow on-screen instructions to add a root user. - If you want to change the port from
5001
to something else, editdocker-compose.yml
file, line- "5001:5001"
to- "<REQUIRED_PORT>:5001"
B.) Using docker directly
We need to setup mongodb manually in this case.
You can use the provided Dockerfile in DBSetup/MongoDB for it or use your own mongodb instace running at port 27017
(default).
If you are using your own mongodb instance, skip to step 5.
cd
to DBSetup/MongoDBdocker build -t mongodb .
Wait for the build to finish.docker run -d -p 27017:27017 --restart=always mongodb
cd
back to the root directorydocker build -t cvfy .
Wait for the build to finish.docker run -d -p 5001:5001 --restart=always cvfy
- Visit
0.0.0.0:5001
and follow the on-screen instructions to add a root user. - If you want to change the port from
5001
, rundocker run -d -p <REQUIRED_PORT>:5001 --restart=always cvfy
instead of command number6
above.
Without docker (only OSX and Linux are supported as of now)
- Setup mongodb as described above (your own or from DBSetup/MongoDB).
- To change the application port, edit
outCalls/config.js
npm i
npm run build -s
npm start -s
Developement
Dev server (unsuitable for deployment)
- Setup mongodb as described above (your own or from DBSetup/MongoDB).
- To change the application port, edit
outCalls/config.js
npm i
npm run dev -s
Production server
(Same as Without Docker
section above under Build instructions
).
(building for production will take some time and require > 1GB ram - use swap if your machine doesn't have meet the requirements)
License
This software is licensed under GNU AGPLv3. Please see the included License
file. All external libraries, if modified, will be mentioned below explicitly.