Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxfierke/resumis
An API and headless CMS for your personal site & CV
https://github.com/maxfierke/resumis
json-api jsonresume personal-site projects rails resume-creator ruby
Last synced: 25 days ago
JSON representation
An API and headless CMS for your personal site & CV
- Host: GitHub
- URL: https://github.com/maxfierke/resumis
- Owner: maxfierke
- License: apache-2.0
- Created: 2014-11-26T18:23:29.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T00:48:59.000Z (29 days ago)
- Last Synced: 2024-10-17T13:45:01.643Z (28 days ago)
- Topics: json-api, jsonresume, personal-site, projects, rails, resume-creator, ruby
- Language: Ruby
- Homepage:
- Size: 2.75 MB
- Stars: 17
- Watchers: 4
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Resumis
Resumis is _Esperanto_ for "summarized". It's also an API and headless CMS for your
personal web presence, a CV generator, and JSON Resume provider.
### Requirements
* Ruby 3.2
* PostgreSQL 12+ with development dependencies
* Node.js 16+
* `wkhtmltopdf`. 0.12.5 recommended. Anything lower has known issues. Will use a binary specified by `WKHTMLTOPDF_PATH` or defaults to `/usr/local/bin/wkhtmltopdf`.
* `vips`/`libvips`
* Redis 6.2+ for Sidekiq
* SMTP server (Production is configured to use SendGrid with credentials set by environmental variables `SENDGRID_USERNAME`, `SENDGRID_PASSWORD`, and `SENDGRID_DOMAIN`). It's only used by Devise for things like password resets, or confirmation emails. This is not a hard dependency and certainly not needed for development.
and others. See [Gemfile](Gemfile).
### Installation & Setup
* Clone the repo
```
$ git clone [email protected]:maxfierke/resumis.git && cd resumis
```
* Install dependencies with Bundler
```
$ bundle install
```
* See [Configuration](#Configuration) below and set any needed environment variables. In development, put them in `.env`.
* Create the database, run the migrations
```
$ rake db:create db:migrate
```
* Run the app using [foreman](https://github.com/ddollar/foreman) or [forego](https://github.com/ddollar/forego)
```
$ foreman start
```
* Create a user for yourself
```
$ rake resumis:useradd -- -e {EMAIL} -p {PASSWORD} -f {FIRST_NAME} -l {LAST_NAME} -d {DOMAIN_NAME} --admin
```
* Go to [localhost:5000](http:/localhost:5000) to log into the management interface.
#### Configuration
Resumis-specific configuration can be done either through the `config/initializers/resumis.rb` initializer file, or through a some environmental variables.
* `SECRET_KEY_BASE` - Generate a value via `rake secret`.
* `RESUMIS_DEVISE_SECRET` - Generate a value via `rake secret`.
* `RESUMIS_MAIL_SENDER` - `From:` address for emails sent by Resumis (password resets, confirmations, etc.)
* `RESUMIS_CANONICAL_HOST` - Canonical hostname.
#### Deploying in Production (preferred)
* [Deploying with Docker](https://github.com/maxfierke/resumis/wiki/Running-Resumis-in-production-with-Docker)
## LICENSE
Apache License 2.0. See LICENSE