https://github.com/refraction-ray/myarxiv-app
Flask app for personal arXiv
https://github.com/refraction-ray/myarxiv-app
celery docker docker-compose flask mysql pytest redis sqlalchemy uikit3 vuejs webpack4
Last synced: 3 months ago
JSON representation
Flask app for personal arXiv
- Host: GitHub
- URL: https://github.com/refraction-ray/myarxiv-app
- Owner: refraction-ray
- License: mit
- Created: 2018-12-25T07:54:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-29T06:14:15.000Z (over 7 years ago)
- Last Synced: 2025-01-30T11:29:48.101Z (over 1 year ago)
- Topics: celery, docker, docker-compose, flask, mysql, pytest, redis, sqlalchemy, uikit3, vuejs, webpack4
- Language: Python
- Size: 238 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MYARIXV-APP
A Flask web app written in Python 3. See the live demo at https://myarxiv.club (at the experimental stage)
## Quickstart
All commands below are executed in bash and the working directory is the root of the project, installation of python (pip) and node (npm) is assumed.
First of all, one need to generate `main.js` and other static files via webpack.
```bash
npm install
npm run build # for development static files
npm run deploy # for production static files
```
* Run the app in development mode, `./run.sh` . You can also use `npm run all` to start both flask and webpack servers for development.
* Run the app in production mode, ` gunicorn -w 4 -b 0.0.0.0:9999 app.wsgi:app`
For the above two options, you need to take care of dependencies. Try
```bash
pip install -r requirements/prod.txt
```
You also need to start celery worker and celery beat manually.
```bash
celery -A app.tasks worker --loglevel=info
celery -A app.tasks beat --loglevel=info
```
* Run the flask app in docker (with database configured in the host). In this case, the host url for databases are recommended as `127.0.0.1` in config.yaml.
```bash
docker build . -t myarxiv:latest
docker run -d --network="host" myarxiv:latest
```
For the above three options, you need to configure mysql and redis databases and their connections manually. In Ubuntu, try `apt install -y redis-server mysql-server libmysqlclient-dev` .
* Run the flask app in docker (with both mysql and redis also in dockers). In this case, the host url for databases are recommended as `mysql` and `redis` respectively in config.yaml.
```bash
docker-compose build
docker-compose up -d
```
For all the above options, Nginx can also be added and configured as the reverse proxy in production mode.