https://github.com/goldengamerlp/keeplist
https://github.com/goldengamerlp/keeplist
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/goldengamerlp/keeplist
- Owner: GoldenGamerLP
- Created: 2024-10-18T20:05:31.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-21T13:32:38.000Z (over 1 year ago)
- Last Synced: 2024-10-22T15:15:22.424Z (over 1 year ago)
- Language: Vue
- Homepage: https://keeplist.vercel.app
- Size: 428 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# KeepTrack
[](https://keeplist.street14.work)
[](https://www.codefactor.io/repository/github/goldengamerlp/keeplist)
## Introduction
KeepList is a simple Wesbite to create Boards with live syncronisation. You can create a Board and share the link with your friends to work together on the same Board.
## How To?
1. Login/Register
2. Create a Board
3. Share the link with your friends or invite them via the Website
4. Work together on the Board
- Test the App [here!](https://keeplist.street14.work/)
# Contribution
Contributions are always welcome! If you have any ideas, just open an issue and describe your idea.
If you want to contribute, fork the repository and create a pull request.
## Nuxt 3 Minimal Starter
Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
## Setup
Make sure to install the dependencies:
```bash
# npm
npm install
# pnpm
pnpm install
# yarn
yarn install
# bun
bun install
```
And make sure you set the following environment variables:
```bash
# .env
MONGODB_URI=mongodb://localhost:27017
MONGODB_DATABASE=keeptlisttest
```
## Development Server
Start the development server on `http://localhost:3000`:
```bash
# npm
npm run dev
# pnpm
pnpm run dev
# yarn
yarn dev
# bun
bun run dev
```
## Production
Build the application for production:
```bash
# npm
npm run build
# pnpm
pnpm run build
# yarn
yarn build
# bun
bun run build
```
Locally preview production build:
```bash
# npm
npm run preview
# pnpm
pnpm run preview
# yarn
yarn preview
# bun
bun run preview
```
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.