Edit Readme.md
This commit is contained in:
23
README.md
23
README.md
@@ -1,27 +1,24 @@
|
|||||||
# stella
|
# stella
|
||||||
|
|
||||||
💧 A project built with the Vapor web framework.
|
💧 A server reimplementation for that one pinball gacha game (you know, that one)
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
To build the project using the Swift Package Manager, run the following command in the terminal from the root of the project:
|
First, run the following command to init the sqlite database into `./db.sqlite`
|
||||||
```bash
|
```bash
|
||||||
swift build
|
swift run stella migrate
|
||||||
```
|
```
|
||||||
|
|
||||||
To run the project and start the server, use the following command:
|
Then, run `mitmproxy` using the following command from the root of this project
|
||||||
```bash
|
```bash
|
||||||
swift run
|
mitmproxy -s ./mitm-redirect-traffic.py
|
||||||
```
|
```
|
||||||
|
|
||||||
To execute tests, use the following command:
|
For more instructions on how to set up mitmproxy, refer to it's documentation.
|
||||||
|
|
||||||
|
Then, start the server by running the following command
|
||||||
```bash
|
```bash
|
||||||
swift test
|
swift run stella serve
|
||||||
```
|
```
|
||||||
|
|
||||||
### See more
|
Things mostly dont work right now, I'm working on it
|
||||||
|
|
||||||
- [Vapor Website](https://vapor.codes)
|
|
||||||
- [Vapor Documentation](https://docs.vapor.codes)
|
|
||||||
- [Vapor GitHub](https://github.com/vapor)
|
|
||||||
- [Vapor Community](https://github.com/vapor-community)
|
|
||||||
|
Reference in New Issue
Block a user