brightdigit / orchardnest Goto Github PK

View Code? Open in Web Editor NEW

open-source web site for swift news, articles, podcasts, and videos

License: MIT License

Swift 49.14% Shell 2.23% CSS 11.87% Dockerfile 1.09% Less 17.73% SCSS 17.95%

orchardnest's Introduction

Swift Articles and News at orchardnest.com

🧐 About

OrchardNest is a site built by Leo Dion and dedicated to the Swift and Apple Developer community by providing a source for news, tutorials, podcasts, YouTube videos, and other updates.

Based on the wonderful iOS Dev Directory by Dave Verwer, this aggreates, filters, curates the variety of RSS feeds availables from developers, designers, podcasters, youtubers and newsletters.

🏁 Getting Started

Here's how to get the server up and running...

Prerequisites

What things you need to install the software and how to install them.

PostgreSQL Server 12.2

Either via server install or docker.

docker run --rm  --name orchardnest-pg -e POSTGRES_HOST_AUTH_METHOD=trust -d -p 5432:5432

Create the database by running the create_db.sql script:

psql -h localhost -U postgres < create_db.sql

Swift 5.2

For details on installing Swift 5.2, check out the instructions from swift.org.

Configuration

These are required environment variables used by OrchardNest:

`DATABASE_URL`

Connection URL to the PostgreSQL database.

`YOUTUBE_API_KEY`

YouTube API Key used for getting YouTube metadata.

🎈 Usage

To run the server simply run:

Running the Server

orchardnestd serve

Running the Scheduled Jobs

orchardnestd queues --scheduled

🚀 Deployment

Here's the current deployment setup for OrchardNest:

Linode for hosting on a ...
With Ubuntu 20.04.1 installed, along with
Using PostgreSQL Server 12.2 for the database
nginx 1.18.0 for the http server
supervisord 4.1.0 for managing processes
Cloudflare for help with caching and serving content

Futher details on the server configuration files can be found in the Configuration directory.

⛏️ Built Using

Server-Side Swift with Vapor 4
PostgreSQL Database with Fluent for Vapor
Job Queue via Vapor Queues Fluent Driver by Matthieu Barthélemy
Plot by John Sundell for HTML Rendering
Ink by John Sundell for Markdown Parsing
Milligram for CSS
Elusive Icons for Icons

✍️ Authors

@leogdion - Idea & Initial work

🎉 Acknowledgements

Thank you to...

Dave Verwer for iOS Dev Weekly, Swift Package Index, but most importantly the iOS Dev Directory which OrchardNest uses to gather content from the community
John Sundell for Publish but also the components OrchardNest uses Ink and Plot for helping render our beautiful web site
The Vapor team for making a solid server-side framework for Swift developers
Linode for hosting this great site

Recommend Projects