This repository has been archived by the owner on May 2, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
04353d4
commit 81a8499
Showing
1 changed file
with
20 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,20 @@ | ||
# README | ||
|
||
This README would normally document whatever steps are necessary to get the | ||
application up and running. | ||
|
||
Things you may want to cover: | ||
|
||
* Ruby version | ||
|
||
* System dependencies | ||
|
||
* Configuration | ||
|
||
* Database creation | ||
|
||
* Database initialization | ||
|
||
* How to run the test suite | ||
|
||
* Services (job queues, cache servers, search engines, etc.) | ||
|
||
* Deployment instructions | ||
|
||
* ... | ||
|
||
## Development | ||
|
||
For hot reload functionality, make sure to have Redis installed. | ||
# Obl.ong | ||
|
||
This is the backbone for Obl.ong, a nonprofit service providing free, quality domains for all. You can run this on your infrastructure if you're looking to manage subdomains or an internal TLD. | ||
|
||
## Building | ||
|
||
- Install Ruby **3.1.2** | ||
- Install Ruby on Rails with Bundler | ||
- Pull submodules | ||
- Run `rails credentials:edit` and add these keys: | ||
``` | ||
dnsimple: | ||
access_token: DNSIMPLE_ACCESS_TOKEN | ||
account_id: ACCOUNT_ID | ||
postmark_api_token: "POSTMARK_API_TOKEN" | ||
``` | ||
- Run `rails tailwindcss:build` | ||
- Edit `config/application.rb` to reflect your environment | ||
- Start the server with `bin/rails server` |