Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/symbux/turbo-starter
A boilerplate application for the Turbo engine with the Turbo Vite SSR plugin installed with Translations, Prisma ORM, Docker build files, Pinia, Vue Router and using Vue 3 + TypeScript.
https://github.com/symbux/turbo-starter
mongo mongodb rest-api typescript vue vue3 websocket
Last synced: 2 days ago
JSON representation
A boilerplate application for the Turbo engine with the Turbo Vite SSR plugin installed with Translations, Prisma ORM, Docker build files, Pinia, Vue Router and using Vue 3 + TypeScript.
- Host: GitHub
- URL: https://github.com/symbux/turbo-starter
- Owner: Symbux
- License: apache-2.0
- Created: 2021-12-07T12:46:52.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-10T01:26:38.000Z (almost 2 years ago)
- Last Synced: 2023-03-05T01:57:44.840Z (over 1 year ago)
- Topics: mongo, mongodb, rest-api, typescript, vue, vue3, websocket
- Language: Vue
- Homepage:
- Size: 452 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Turbo Starter Project
This is a boilerplate/starter project for the Turbo engine.
## Features
* Turbo Engine
* MongoDB
* Prisma ORM _(Turbo initialises this)_.
* Translations
* Docker build file.
* Vue 3
* Vue Router
* Pinia (Vuex replacement)
* TypeScript
* Eslint
## Project Setup
**Clone the repository.**
```sh
git clone [email protected]:Symbux/Turbo-Starter.git
cd
```
**Setup the project.**
_This will install any required dependencies in both the web and api folders._
```sh
yarn setup
```
**Copy and fill out the environment file.**
_Make sure that the port you use in the .env file is the same as the one in the `vite.config.js` file._
```sh
cp api/.env.example api/.env
```
**Generate the prisma client.**
_This will generate the prisma client with all the types based on the schema._
```sh
yarn prisma:gen
```
**Database Configuration.**
_Prisma ORM requires that the MongoDB instance is setup as a replica set, in the `./db` folder there is an example single node cluster for development, we suggest that for large scale production apps you configure a multi-node replica set, or using something like Mongo Atlas._
```sh
cd ./db
docker-compose up -d
# Only run the below once on first launch of the database (the setting is saved after restarts).
docker-compose exec mongo mongo --eval "rs.initiate({_id: 'rs0', members: [{_id: 0, host: '127.0.0.1:27017'}]});"
```
You are now all set, see the next section to start developing.
## Developing
**Run the development server.**
_This will launch the Vite dev server and the turbo engine in dev mode together._
```sh
yarn dev
```
**Run the dev server's seperately.**
_If you want to launch the dev servers separately, because you want to see the logs better, you can run the following commands in two different terminals._
```sh
yarn dev:api
yarn dev:web
```
**Navigate to browser.**
_This will be the Vite dev server, proxying all connections to your turbo app._
```sh
http://localhost:3000
```
## Building
**Build the project.**
_This will build both projects, and the API will host the built Vue files._
```sh
yarn build
```
**Build only the API.**
_This will build the API only._
```sh
yarn build:api
```
**Build only the web.**
_This will build the web only._
```sh
yarn build:web
```
## Launching Production
> Make sure you have built the application first!
**Start the server.**
_This will start the Turbo engine which will host the built Vue files._
```sh
yarn start
```