Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mamantoha/shards-info

Source code of https://shards.info/
https://github.com/mamantoha/shards-info

crystal crystal-shards github gitlab hacktoberfest

Last synced: 2 months ago
JSON representation

Source code of https://shards.info/

Host: GitHub
URL: https://github.com/mamantoha/shards-info
Owner: mamantoha
License: mit
Created: 2018-03-18T12:34:32.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-09-26T10:50:03.000Z (3 months ago)
Last Synced: 2024-09-30T03:20:22.781Z (3 months ago)
Topics: crystal, crystal-shards, github, gitlab, hacktoberfest
Language: Crystal
Homepage:
Size: 9.18 MB
Stars: 38
Watchers: 5
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

[![Built with Crystal](https://img.shields.io/badge/built%20with-Crystal-000000.svg?logo=appveyor)](https://crystal-lang.org/)

[![Crystal CI](https://github.com/mamantoha/shards-info/actions/workflows/crystal.yml/badge.svg)](https://github.com/mamantoha/shards-info/actions/workflows/crystal.yml)

[![ESLint](https://github.com/mamantoha/shards-info/actions/workflows/eslint.yml/badge.svg)](https://github.com/mamantoha/shards-info/actions/workflows/eslint.yml)

[![Stylelint](https://github.com/mamantoha/shards-info/actions/workflows/stylelint.yml/badge.svg)](https://github.com/mamantoha/shards-info/actions/workflows/stylelint.yml)

View of all repositories on Github and Gitlab that have Crystal code in them.

[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://vshymanskyy.github.io/StandWithUkraine)

## Installation

- [Install](https://crystal-lang.org/docs/installation/) Crystal

- Clone this repository

- Install dependencies `shards install`

- Rename `.env.example` to `.env`, and set variables.

- Run Web server as `crystal src/web.cr`

## Development

```console

psql -c 'CREATE DATABASE shards_info_development;' -U postgres

crystal src/cli.cr migrate

```

### Frontend

Install depencencies:

```console

npm install

```

After modifications run `npm run build`

## Specs

Prepare a database:

```console

crystal spec/initdb.cr

```

Run specs:

```console

KEMAL_ENV=test crystal spec

```

## Special thanks

- [Crystal language](https://crystal-lang.org/)

- [Clear](https://github.com/anykeyh/clear) - Advanced ORM between PostgreSQL and Crystal

- [Kemal](https://github.com/kemalcr/kemal) - Web microframework for Crystal

- [Mosquito](https://github.com/robacarp/mosquito) - A generic background task runner for Crystal applications

- [raven.cr](https://github.com/Sija/raven.cr) - Crystal client for [Sentry](https://sentry.io)

- [cr-cmark-gfm](https://github.com/amauryt/cr-cmark-gfm) - Crystal C bindings for [cmark-gfm](https://github.com/github/cmark-gfm)

- [noir](https://github.com/MakeNowJust/noir) - Syntax Highlight Library for Crystal

- Logo [icon](https://game-icons.net/1x1/lorc/floating-crystal.html) taken from [Game Icons pack](https://game-icons.net/) under CC BY 3.0 license.

## Contributing

1. Fork it ()

2. Create your feature branch (git checkout -b my-new-feature)

3. Commit your changes (git commit -am 'Add some feature')

4. Push to the branch (git push origin my-new-feature)

5. Create a new Pull Request

## Contributors

- [mamantoha](https://github.com/mamantoha) Anton Maminov - creator, maintainer