Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mzogheib/billions

Interactions with the Discogs API
https://github.com/mzogheib/billions

discogs discogs-api

Last synced: about 2 months ago
JSON representation

Interactions with the Discogs API

Host: GitHub
URL: https://github.com/mzogheib/billions
Owner: mzogheib
Created: 2020-03-07T10:17:56.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-01-27T09:04:46.000Z (almost 2 years ago)
Last Synced: 2023-03-01T11:06:13.546Z (almost 2 years ago)
Topics: discogs, discogs-api
Language: TypeScript
Homepage:
Size: 2.26 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 17
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

# Billions

Interactions with the [Discogs API](https://www.discogs.com/developers)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Getting Started

1. Clone the repo
2. Create a `.env` file in the root directory. Get your personal access token [here](https://www.discogs.com/settings/developers).

```bash
REACT_APP_DISCOGS_TOKEN=replace-with-personal-access-token
```

3. Start

```bash
yarn start
```

## Linting & Code Formatting

- https://www.robertcooper.me/using-eslint-and-prettier-in-a-typescript-project

## Development & Release Process

### Pre-development

- Create an issue in GitHub describing the required changes

### Development

- Create a feature branch off `master` and reference the issue number in the name, e.g.

```
git checkout -b ISSUE/#23
```

- Develop and commit. Commit messages can be anything, short and meanigful
- When a feature is complete push the branch to remote and raise a PR
- Ensure the PR title follows the [Conventional Commits specification](https://conventionalcommits.org) specification. An example title is

```
feat: New results page
```

- Squash & merge the PR to `master`

#### Notes

- Commit messages on `master` in the CLI are enforced via [commitlint](https://github.com/conventional-changelog/commitlint)
- PR titles on GitHub are enforced via [Semantic Pull Requests](https://github.com/zeke/semantic-pull-requests)

### Release

- Based on the commit messages [standard-version](https://github.com/conventional-changelog/standard-version) is used to bump version and generate the changelog

```bash
yarn release
yarn publish-release
```

## TODO

- Add React Playroom
- Add Storybook
- Split into monorepo so that Playroom and Storybook are in separate packages

## Random things

- Should each screen specify padding or should it be global in a root Box?