https://github.com/nicka/composr
React website for www.composrapp.com deployed with the Serverless Framework.
https://github.com/nicka/composr
Last synced: about 1 month ago
JSON representation
React website for www.composrapp.com deployed with the Serverless Framework.
- Host: GitHub
- URL: https://github.com/nicka/composr
- Owner: nicka
- Created: 2017-07-14T13:24:25.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-14T13:25:02.000Z (about 9 years ago)
- Last Synced: 2025-11-12T15:29:40.583Z (9 months ago)
- Language: JavaScript
- Size: 72.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Composr
Composr, lets you record and compose songs socially. Collaborate with musicians from all over the world.
### Prerequisites
For node module management, Composr uses [Yarn](https://yarnpkg.com/) over NPM.
To install yarn globally on your machine please check [Installing Yarn](https://yarnpkg.com/en/docs/install#mac-tab).
# Quick Start
1. Setup project
>This is a convenience method to install a pre-made Serverless Service locally by downloading the Github repo and unzipping it. Services are listed below.
```bash
serverless install -u https://github.com/nicka/composr-react
```
2. Install development dependencies
```bash
yarn
```
# React
## Start locally
```bash
yarn start
```
## Build
Create development build artifacts.
```bash
yarn run build
```
Create production build artifacts.
```bash
yarn run build:prod
```
## Deploy
Deploy build artifacts.
```bash
STAGE="dev" yarn run sls:client:deploy
```
# Test
For testing Composr uses [Jest](https://facebook.github.io/jest/), for more information please check their [documentation](https://facebook.github.io/jest/#getting-started).
>NOTE: To update Jest snapshots supply ` -- -u` to any of the test commands.
**Running the tests**
```bash
yarn run test
```
**Code coverage**
In order to inspect code coverage:
```bash
open coverage/lcov-report/index.html
```