Museon Web

A free and open-source music platform

Development

Installing Dependencies

$ npm install
# or
$ yarn

Environments

• Copy .env.local.template to .env.local on same structure level.
• Fill required environment variables.

Environment	Type	Recommendation for Development	Description
GRAPHQL_ENDPOINT	String	http://localhost:4000/graphql	GraphQL Server Endpoint

Running GraphQL Server

Clone museon-backend repository and run GraphQL server:

$ npm start

Now, server should be running on http://localhost:4000/graphql

Running App

Running the development server:

$ npm run dev
# or
$ yarn dev

Open http://localhost:3000 with your browser to see the result.

Building:

$ npm run build
# or
$ yarn build

Linting:

$ npm run lint
# or
$ yarn lint

Testing:

$ npm test
# or
$ yarn test

Analyzing bundle:

$ npm run analyze
# or
$ yarn analyze

Containerization with Docker

$ docker-compose build
# run
$ docker-compose up

Contributing

Please, follow these steps to contribute:

1. Fork the repository
2. Create a branch
3. Commit your changes
4. Run build, lint and test scripts
5. Create pull request