Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jungrama/syncboard
https://github.com/jungrama/syncboard
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jungrama/syncboard
- Owner: JungRama
- Created: 2023-11-07T00:00:37.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-06T06:34:44.000Z (about 1 year ago)
- Last Synced: 2024-04-22T14:56:18.856Z (9 months ago)
- Language: TypeScript
- Homepage: https://syncboard.jungrama.com
- Size: 5.98 MB
- Stars: 18
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Syncboard - AI Powered Real-time Whiteboard
Syncboard is a user-friendly board editor that lets you draw and work together with your team in real-time. It also has a handy AI feature that helps you make diagrams and flowcharts effortlessly.
## What's inside?
This project using Turborepo includes the following packages/apps:
### Apps and Packages
- `api`: Backend services created with express and using graphql
- `web`: Frontend service using nextjs
- `ui`: React component for ui library using `shadcn/ui` shared for `web` applications
- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `tsconfig`: `tsconfig.json`s used throughout the monorepo
### Built With
- [Next.js](https://nextjs.org/)
- [Express](https://expressjs.com/)
- [GraphQL](https://graphql.org/)
- [Apollo GraphQL](https://www.apollographql.com/)
- [Shadcn/ui](https://ui.shadcn.com/)
### Want to running the project localy?
Run the following command:
1. Clone the repo into a public GitHub repository (or fork https://github.com/JungRama/syncboard/fork).
```sh
git clone https://github.com/JungRama/syncboard.git
```
2. Go to the project folder
```sh
cd syncboard
```
3. Install packages
```sh
npm install
yarn install
pnpm install
```
4. Set up your `.env` file on apps/web and apps/api
5. Run development mode on root folder
```sh
npm run dev
yarn run dev
pnpm run dev
```
Access the frontend in `localhost:3000`, sometimes when this port used it will be using other available port.
Access the backend in `localhost:4000/graphql`
For the Websocket service `localhost:1234`