Skip to content

Latest commit

 

History

History
155 lines (112 loc) · 3.82 KB

README.md

File metadata and controls

155 lines (112 loc) · 3.82 KB
Raw

Logo

Woovi Playground

Report Bug

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. Contact

Built With

Next React Node GraphQL MongoDB Koa

(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

    https://nodejs.org/en/download/

  • PNPM

    npm install pnpm -g

  • Docker

    https://www.docker.com/get-started/

Installation

Clone the repo

git clone https://github.com/entria/woovi-playground.git

  1. Install packages

    pnpm install

  2. Run the container(or stop it, if necessary):

    pnpm compose:up

  3. Setup Configuration

    pnpm config:local

  4. Run the relay

    pnpm relay

  5. Run the Project

    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

(back to top)