blacklight/scribe
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
scribe/README.md
Edward Loveall dbddfc9cb4
Update README
2021-10-10 14:52:37 -04:00

1.9 KiB
Raw Blame History

Scribe - An Alternative Medium Frontend

This is a project written using Lucky. It's main website is scribe.rip.

Deploying Your Own

I'd love it if you deploy your own version of this app! To do so currently will take some knowledge of how a webserver runs. If you want to give it a shot, there are a bunch of different ways to deploy. The main site runs on Ubuntu but there are also directions for Heroku or Dokku.

One thing to note is that this app doesn't currently use a database. Any instructions around postgres can be safely ignored. Lucky (and it's dependency Avram) however does need a DATABASE_URL formatted for postgres. It doesn't need to be the URL of an actual database server though. Here's mine: DATABASE_URL=postgres://does@not/mater

Hopefully a more comprehensive guide will be written at some point, but for now feel free to reach out if you have any questions. My contact info can be found on my website.

Contributing

  1. Install required dependencies
  2. Run script/setup
  3. Run lucky dev to start the app
  4. Send me a patch
  • To be honest, I'm not sure how I feel about the send patch git workflow as opposed to the GitHub style pull request workflow. I'm trying it out for now. If you can't figure it out, get in contact and we can figure out a way to get your contributions in.

Learning Lucky

Lucky uses the Crystal programming language. You can learn about Lucky from the Lucky Guides.