Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/woovibr/woovi-playground


https://github.com/woovibr/woovi-playground

Last synced: 5 days ago
JSON representation

Awesome Lists containing this project

README

        





Logo

Woovi Playground


Report Bug


Table of Contents



  1. About The Project



  2. Getting Started


  3. Contributing

  4. Contact

### 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]

(back to top)

## 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

(back to top)

## Contact

Project Link: [https://github.com/entria/woovi-playground](https://github.com/entria/woovi-playground)

(back to top)

[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