mirror of
https://github.com/pawelmalak/flame.git
synced 2025-07-18 19:19:36 +02:00
42 lines
633 B
Markdown
42 lines
633 B
Markdown
|
# 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
|