Updated README.md
This commit is contained in:
29
README.md
29
README.md
@@ -1,5 +1,32 @@
|
||||
# Kakubovna
|
||||
|
||||
A simple file sharing platform
|
||||
A "simple" file sharing platform
|
||||
|
||||
# NOT FINISHED, i am doing my best
|
||||
|
||||
# Quick start
|
||||
## Docker
|
||||
```bash
|
||||
git clone https://github.com/Dzejkobik007/skolavdf.git
|
||||
cd Kakubovna/docker
|
||||
docker-compose up -d --build
|
||||
```
|
||||
## Manual
|
||||
```bash
|
||||
# Install required tools with your system package manager
|
||||
sudo apt install git node npm
|
||||
|
||||
git clone https://github.com/Dzejkobik007/skolavdf.git
|
||||
cd Kakubovna/app
|
||||
npm install --production
|
||||
nodejs app.js
|
||||
```
|
||||
|
||||
|
||||
## Dependencies
|
||||
|
||||
- [express](https://github.com/expressjs/express)
|
||||
- [socket.io](https://github.com/socketio/socket.io)
|
||||
- [socketio-file-upload](https://github.com/sffc/socketio-file-upload)
|
||||
- [better-sqlite3](https://github.com/socketio/socket.io)
|
||||
- [loglevel](https://github.com/pimterry/loglevel)
|
||||
Reference in New Issue
Block a user