Git Product home page Git Product logo

changelog.com's Introduction

changelog.com CircleCI All Contributors Coverage Status

Read the announcement post!

What is this?

This is the CMS behind changelog.com. It's an Elixir application built with the Phoenix web framework, PostgreSQL, and many other great open source efforts.

Why is it open source?

A few reasons:

  1. We love open source. Our careers (and livelihoods) wouldn't be possible without open source. Keeping it closed just feels wrong.
  2. Phoenix is really great, but it's young enough in its lifecycle that there aren't too many in-production, open source sites for people to refer to as examples or inspiration. We want to throw our hat into that ring and hopefully others will follow.
  3. Changelog is a community of hackers. We know open sourcing the website will lead to good things from y'all (such as bug reports, feature requests, and pull requests).

Should I fork this and use it as a platform?

Probably not. We won't stop you from doing it, but we don't advise it. This is not a general purpose podcasting CMS. It is a CMS that is specific to Changelog and our needs. From the design and layout to the data structures and file hosting, we built this for us. An example of just how custom it is β€” we literally have our podcast names hardcoded in areas of the code. Yuck.

What is it good for?

If you're building a web application with Phoenix (or aspire to), this is a great place to poke around and see what one looks like when it's all wired together. It's not perfect by any means, but it works. And that's something. We've also been told that it is ridiculously fast.

If you have questions about any of the code, holler @Changelog. Better yet, join the community where we have in-depth discussions about software development, industry trends, and everything else under the sun.

How can I contribute?

Assuming that you have Docker running locally and docker-compose available, all you have to do is run rm -fr deps && docker-compose up in your terminal. When you run this command for the first time, it will take around 7 minutes to pull all Docker images, build the app image and start all containers. Depending on your internet connection and CPUs used for compiling various artefacts, this can easily take 30 minutes or more. Next time you run this command, since all Docker images will be cached, you can expect all containers to be up and running within 30 seconds.

When all containers are up and running, you should see the following output in your terminal session:

Starting changelogcom_db_1    ... done
Starting changelogcom_proxy_1 ... done
Recreating changelogcom_app_1 ... done
Attaching to changelogcom_db_1, changelogcom_proxy_1, changelogcom_app_1
...
db_1     | LOG:  autovacuum launcher started
db_1     | LOG:  database system is ready to accept connections
...
proxy_1  | dockergen.1 | 2018/07/20 16:01:05 Generated '/etc/nginx/conf.d/default.conf' from 3 containers
...
app_1    | [info] Running ChangelogWeb.Endpoint with Cowboy using http://0.0.0.0:4000
app_1    | yarn run v1.6.0
app_1    | warning package.json: No license field
app_1    | $ webpack --mode=development --watch-stdin --color
app_1    |
app_1    | Webpack is watching the files…
...

You can access a dev copy of changelog.com locally, at http://localhost:4000

When you want to stop all Docker containers required to run a dev copy of changelog.com locally, press CTRL key and c at the same time (Ctrl+C).

If any app dependencies have changed, or the cached Docker app image has diverged from the source code, you will need to re-build it by running docker-compose build before you can run docker-compose up.

If you are running on macOS or Linux, all the above commands are available as make targets (e.g. build & contrib). Learn about all available commands by running make in your terminal.

By default, macOS ships with GNU Make v3.81. Our Makefile requires GNU Make >= 4 which can be installed via brew install make. By default, the make version that brew installs is invoked via gmake. For more info, see brew info make.

Please remember that we have a product roadmap in mind so open an issue about the feature you'd like to contribute before putting the time in to code it up. We'd hate for you to waste any of your time building something that may ultimately fall on the cutting room floor.

Why is Docker for Mac slow?

If you are running changelog.com locally via docker-compose up on a Mac, you might notice that pages take ~1.5s to load:

while true
do
  curl --silent --output /dev/null \
  --write-out '%{http_code} connect:%{time_connect} prepare:%{time_pretransfer} transfer:%{time_starttransfer} total:%{time_total}\n' \
  http://localhost:4000/
done
200 connect:0.004815 prepare:0.004849 transfer:1.488685 total:1.488921
200 connect:0.005061 prepare:0.005089 transfer:1.627873 total:1.628171
200 connect:0.005176 prepare:0.005211 transfer:1.566022 total:1.566123
^C

This is down to Docker for Mac networking integration with the OS, which is still the case in 18.09.0-ce-beta1.

The same test on Arch Linux 2018.10.1 running Docker 18.06.1-ce results in ~0.08s response times (20x faster):

200 connect:0.000569 prepare:0.000602 transfer:0.080425 total:0.080501
200 connect:0.000614 prepare:0.000650 transfer:0.083291 total:0.083407
200 connect:0.000611 prepare:0.000643 transfer:0.081731 total:0.081853
^C

Our thinking is: make it work first, make it right next & make it fast last. Contributions to make changelog.com dev on Docker for Mac fast are welcome! It would be especially interesting to know if ipvlan on macOS makes things better.

Code of Conduct

Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributors

Thanks goes to these wonderful people (emoji key):

Jerod Santo
Jerod Santo

πŸ’» πŸ“– πŸš‡
Adam Stacoviak
Adam Stacoviak

🎨 πŸ’» πŸ’΅
Cody Peterson
Cody Peterson

🎨 πŸ’»
Jake Stutzman
Jake Stutzman

🎨
Tucker Cowie
Tucker Cowie

πŸ’»
Gerhard Lazu
Gerhard Lazu

πŸš‡ πŸ’»
Xinjiang Shao
Xinjiang Shao

πŸ“– πŸ’»
Steve Agalloco
Steve Agalloco

πŸ’»
David Gasperoni
David Gasperoni

πŸ’»
Nathan Youngman
Nathan Youngman

⚠️
Marco Vito Moscaritolo
Marco Vito Moscaritolo

πŸ’»
0x4e
0x4e

πŸ’»
Andrea Rossi
Andrea Rossi

πŸ’»
Tonći Galić
Tonći Galić

πŸš‡
Jearvon Dharrie
Jearvon Dharrie

πŸ’»
Lee Jarvis
Lee Jarvis

Agusti Fernandez
Agusti Fernandez

πŸ’»
Len Payne
Len Payne

πŸ’»
JoeBew42
JoeBew42

πŸ’»
Griffin Byatt
Griffin Byatt

πŸ’»
Ridge Frederick
Ridge Frederick

πŸ’» πŸ›
Horst Rutter
Horst Rutter

πŸ›
Nick Janetakis
Nick Janetakis

πŸ› πŸ’»
Ryan Will
Ryan Will

πŸ› πŸ’»
Dennis Reimann
Dennis Reimann

πŸ’»
Juan Soto
Juan Soto

πŸ’»
Jordy Zomer
Jordy Zomer

πŸ’»
Kevin Ball
Kevin Ball

πŸ’»
Mat Ryer
Mat Ryer

πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!

changelog.com's People

Contributors

jerodsanto avatar codyjames avatar gerhard avatar adamstac avatar jsunsawyer avatar tuckercowie avatar ericrowan avatar dennisreimann avatar soleo avatar nickjj avatar allcontributors[bot] avatar stve avatar kball avatar lenpayne avatar leejarvis avatar joebew42 avatar mcdado avatar bacanu avatar visar avatar tuxified avatar thth avatar ryanwilldev avatar r-frederick avatar tambry avatar pedrosnk avatar nathany avatar michaeljdennis avatar matryer avatar tarebyte avatar mavimo avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.