https://github.com/fairdataihub/nuxt-starter
https://github.com/fairdataihub/nuxt-starter
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fairdataihub/nuxt-starter
- Owner: fairdataihub
- Created: 2025-05-02T06:26:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-25T23:30:35.000Z (about 1 year ago)
- Last Synced: 2025-06-26T00:29:04.663Z (about 1 year ago)
- Language: Vue
- Size: 198 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nuxt Starter
## Getting started
### Prerequisites/Dependencies
You will need the following installed on your system:
- Node.js
- Yarn
- Docker
- Volta (optional)
### Setup
1. Clone the repository
```bash
git clone https://github.com/fairdataihub/nuxt-starter.git
```
2. Install the dependencies
```bash
yarn install
```
3. Add your environment variables. An example is provided at `.env.example`
```bash
cp .env.example .env
```
4. Start the development server
```bash
yarn dev
```
5. Open the application in your browser
```bash
open http://localhost:3000
```
## Development
### Database
The application uses a PostgreSQL database for storing data. You can use Docker to run these services locally.
```bash
docker-compose -f ./dev-docker-compose.yaml up
docker-compose -f ./dev-docker-compose.yaml up -d # if you want the db to run in the background
```
Close the database with:
```bash
docker-compose -f ./dev-docker-compose.yaml down
```
### Prisma
The application uses Prisma to interact with the database.
### UI
The application uses [Nuxt UI](https://ui.nuxt.com) to build the UI components. It also uses [Tailwind CSS](https://tailwindcss.com) for styling.