devexcuses-api

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 20 Open GitHub ↗

🤷‍♂️ An API for lazy coders’ excuses

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# devexcuses-api

[![Build status](https://github.com/michelegera/devexcuses-api/actions/workflows/build.yml/badge.svg)](https://github.com/michelegera/devexcuses-api/actions/workflows/build.yml)

> What’s your excuse?

`devexcuses-api` provides a modern, RESTful, scalable solution to developers’
common problem of finding an excuse to justify their sloppy work.

Visit https://devexcuses-api.onrender.com/ to get your random excuse!

## Translations

The API is currently available in the following languages:

- English (default)
- French

To get a random excuse in a specific language, use a `locale` query parameter:

```bash
curl "https://devexcuses-api.onrender.com/?locale=fr"
```

## Installation

bundle install

# SSL support in development, defaults to port 9292
    brew install mkcert
    brew install nss
    mkcert -install
    mkcert localhost

## Run

rails server

## Test

bundle exec rspec

## Contributing

To add new excuses:

1. Fork the repository into your account
2. Branch into a feature branch `feature/your-excuse`
3. Add excuses at the bottom of `data/excuses.yml` using the following format:

```yaml
   - id: 55
     text_en: "I’m not getting any error codes."
     # …
   ```

4. Push to your fork and submit a PR.

To add a new language:

1. Fork the repository into your account
2. Branch into a feature branch, e.g. `i8n/it`
3. Add a new locale in `config/application.rb`

```ruby
   config.i18n.available_locales = %i[en fr it]
   ```

4. Add translated excuses in `data/excuses.yml` using the following format:

```yaml
   - id: 55
     text_en: "I’m not getting any error codes."
     # …
     text_it: "Non ricevo alcun codice di errore."
   ```

5. Edit `models/excuse.rb` to add a `field` for the new language:

```ruby
   field :text_it
   ```

6. Push to your fork and submit a PR.

All contributions are very welcome.

[wasp]: https://wasp-lang.dev/docs/tutorials/dev-excuses-app

devexcuses-api

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README