devdocs

(β˜… 39,332)

API Documentation Browser

  • .dockerignore
  • .editorconfig
  • .gitignore
  • .image_optim.yml
  • .ruby-version
  • .slugignore
  • .tool-versions
  • config.ru
  • COPYRIGHT
  • Dockerfile
  • Dockerfile-alpine
  • Gemfile
  • Gemfile.lock
  • LICENSE
  • newrelic.yml
  • package-lock.json
  • Procfile
  • Rakefile
  • README.md
  • renovate.json
  • techstack.md
  • techstack.yml
  • Thorfile

# Installation Guide

1. Get the code
git clone https://github.com/freeCodeCamp/devdocs

Downloads the entire project code from GitHub to your computer.

cd devdocs

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Ruby Ruby is required to use gem.
gem install bundler

Installs the package published on RubyGems directly.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest

Runs the built image as an actual container.

docker build -t devdocs .

Builds a runnable image based on the Dockerfile.

docker run --name devdocs -d -p 9292:9292 devdocs

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
bundle install

Installs the Ruby libraries listed in the Gemfile.

bundle exec thor docs:download --default

Type this command into your terminal and run it.

bundle exec rackup

Type this command into your terminal and run it.

βœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

Pulled directly from this repo's README.

// repository documentation