Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/woovibr/woovi-playground
https://github.com/woovibr/woovi-playground
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/woovibr/woovi-playground
- Owner: woovibr
- Created: 2023-04-17T01:56:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-13T12:53:06.000Z (4 months ago)
- Last Synced: 2024-08-01T21:56:51.752Z (4 months ago)
- Language: TypeScript
- Size: 332 KB
- Stars: 31
- Watchers: 7
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of Contents
### Built With
[![Next][next.js]][next-url]
[![React][react.js]][react-url]
[![Node][node.js]][node-url]
[![GraphQL][graphql]][graphql-url]
[![MongoDB][mongodb]][mongodb-url]
[![Koa][koa]][koa-url]
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- Node.js
```sh
https://nodejs.org/en/download/
```
- PNPM
```sh
npm install pnpm -g
```
- Docker
```sh
https://www.docker.com/get-started/
```
## Installation
Clone the repo
```sh
git clone https://github.com/entria/woovi-playground.git
```
1. Install packages
```sh
pnpm install
```
2. Run the container(or stop it, if necessary):
```sh
pnpm compose:up
```
3. Setup Configuration
```sh
pnpm config:local
```
4. Run the relay
```sh
pnpm relay
```
5. Run the Project
```sh
pnpm dev
```
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)
3. Commit your Changes (`git commit -m 'feat(amazing-feature): my feature is awesome'`)
4. Push to the Branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## Contact
Project Link: [https://github.com/entria/woovi-playground](https://github.com/entria/woovi-playground)
[next.js]: https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[next-url]: https://nextjs.org/
[react.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[react-url]: https://reactjs.org/
[node.js]: https://img.shields.io/badge/NodeJS-339933?style=for-the-badge&logo=nodedotjs&logoColor=white
[node-url]: https://nodejs.org/
[graphql]: https://img.shields.io/badge/Graphql-E10098?style=for-the-badge&logo=graphql&logoColor=white
[graphql-url]: https://graphql.org/
[mongodb]: https://img.shields.io/badge/MongoDB-47A248?style=for-the-badge&logo=mongodb&logoColor=white
[mongodb-url]: https://mongodb.com
[koa]: https://img.shields.io/badge/Koa-F9F9F9?style=for-the-badge&logo=koa&logoColor=33333D
[koa-url]: https://koajs.com
