mirror of
https://github.com/pawelmalak/flame.git
synced 2025-07-19 03:29:37 +02:00
Docker build. Catch client routes on server. Initial config utility
This commit is contained in:
parent
d2e6ebae4f
commit
1636b705de
10 changed files with 125 additions and 13 deletions
42
README.md
Normal file
42
README.md
Normal file
|
@ -0,0 +1,42 @@
|
|||
# Flame
|
||||
|
||||
## Description
|
||||
Flame is self-hosted startpage for your server. It's inspired (heavily) by [SUI](https://github.com/jeroenpardon/sui)
|
||||
|
||||
## Technology
|
||||
- Backend
|
||||
- Node.js + Express
|
||||
- Sequelize ORM + SQLite
|
||||
- Frontend
|
||||
- React
|
||||
- Redux
|
||||
- TypeScript
|
||||
- Deployment
|
||||
- Docker
|
||||
|
||||
## Development
|
||||
```sh
|
||||
git clone https://github.com/pawelmalak/flame
|
||||
cd flame
|
||||
|
||||
# run only once
|
||||
<TODO>
|
||||
|
||||
# start backend and frontend development servers
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## Deployment with Docker
|
||||
```sh
|
||||
# build image
|
||||
docker build -t flame .
|
||||
|
||||
# run container
|
||||
docker run \
|
||||
-p 5005:5005 \
|
||||
-v <host_dir>:/app/data \
|
||||
flame
|
||||
```
|
||||
|
||||
## Functionality
|
||||
todo
|
Loading…
Add table
Add a link
Reference in a new issue