https://github.com/olyop/musicloud
https://github.com/olyop/musicloud
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/olyop/musicloud
- Owner: olyop
- License: mit
- Created: 2021-10-06T00:41:45.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-09T11:40:26.000Z (over 3 years ago)
- Last Synced: 2025-03-29T04:41:31.278Z (about 1 year ago)
- Language: TypeScript
- Size: 4.84 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# Development Setup
## Install Node.JS v18
[Official Download](https://nodejs.org/en/download/current/)
Or use [Volta](https://volta.sh/) (preferred)
## Clone Repository
```bash
$ git clone https://github.com/olyop/musicloud.git
```
## Install Dependencies
```bash
$ cd musicloud
$ volta install
$ npm i
```
## Create `.env` file
```bash
$ cp .env.template .env
$ vim .env
```
Setup a PostgreSQL database and AWS S3 bucket and fill these out with you're own details:
```properties
AWS_REGION=""
AWS_ACCESS_KEY_ID=""
AWS_ACCESS_KEY_SECRET=""
POSTGRESQL_DATABASE=""
POSTGRESQL_USERNAME=""
POSTGRESQL_PASSWORD=""
POSTGRESQL_HOSTNAME=""
ALGOLIA_SEARCH_INDEX_NAME=""
ALGOLIA_APPLICATION_ID=""
ALGOLIA_ADMIN_API_KEY=""
ALGOLIA_SEARCH_API_KEY=""
```
If you want to use https in development, sign you're own certificate with `mkcert` using this [Guide](https://web.dev/how-to-use-local-https/) and set these environment variables:
```properties
HTTPS=true
TLS_CERTIFICATE_PATH=""
TLS_CERTIFICATE_KEY_PATH=""
```
## Start Development Server
```bash
$ npm start
```
## Build and test
Set `TESTING=true` in `.env`
```bash
$ npm run build
```