Skip to content

Commit e457588

Browse files
authored
Took out Docker info
1 parent c3bd3eb commit e457588

File tree

1 file changed

+0
-47
lines changed

1 file changed

+0
-47
lines changed

README.md

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -12,53 +12,6 @@
1212

1313
We **highly** recommend [VS Code](https://code.visualstudio.com/) for its great plugins. The project is also setup for auto-linting with VSCode on file save! You'll need at least the [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) plugin. Once you open the source code in VSCode, some other convenient plugins should also be recommended to you.
1414

15-
## Running the App
16-
17-
Using Docker is the best way to run the app for development, but if you have `pnpm` installed locally you can run it like any old Vue application. **Please use only pnpm to run the project or handle dependencies!** Different tools like `yarn` and `npm` are not interoperable with `pnpm` (or each other) and will cause problems when intermingled.
18-
19-
Once you have Docker running, you can build a container and enter it with
20-
21-
```
22-
./scripts/start.sh
23-
```
24-
25-
Once inside, run
26-
27-
```
28-
pnpm install
29-
```
30-
31-
To install the necessary packages, then run
32-
33-
```
34-
pnpm dev
35-
```
36-
37-
to start the development server. The app will run on port 8080 so make sure that is available on your local machine or you probably won't be able to access the app in your browser.
38-
39-
To exit the conainer, shut down the dev server with `ctrl + c` and you can just type `exit`.
40-
41-
To shut down the container, use
42-
43-
```
44-
./scripts/stop.sh
45-
```
46-
47-
You may need to rebuild the container from time to time and can do that with
48-
49-
```
50-
./scripts/rebuild.sh
51-
```
52-
53-
## Testing
54-
55-
We use Vitest for testing, which has a hot reloading feature. This means you can write a test and it will re-run when you save the test file or the source file for the code you're testing. You can start this with
56-
57-
```
58-
pnpm test
59-
```
60-
61-
6215
# Features & Implementation Details
6316

6417

0 commit comments

Comments
 (0)