podverse-web

(β˜… 100)

Podverse web app written with React and Next.js

  • .dockerignore
  • .editorconfig
  • .env.example
  • .env.local-prod-data.example
  • .eslintrc
  • .git-blame-ignore-revs
  • .gitignore
  • .lintstagedrc
  • .npmrc
  • .nvmrc
  • .prettierignore
  • .prettierrc
  • .stylelintrc.json
  • Dockerfile
  • Jenkinsfile
  • jest.config.js
  • jest.setup.js
  • LICENSE
  • next-env.d.ts
  • next-i18next.config.js
  • next.config.js
  • package-lock.json
  • package.json
  • README.md
  • sentry.client.config.js
  • sentry.properties
  • sentry.server.config.js
  • tsconfig.json
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/podverse/podverse-web

Downloads the entire project code from GitHub to your computer.

cd podverse-web

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
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 build -t podverse-web .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 podverse-web

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.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm run dev

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd public/3rd-party/Fork-Awesome-1.2.0

This project's files live in a subfolder, so move into it first.

composer install

Installs the PHP libraries listed in composer.json.

βœ… Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

5. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd public/3rd-party/Fork-Awesome-1.2.0

This project's files live in a subfolder, so move into it first.

bundle install

Installs the Ruby libraries listed in the Gemfile.

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

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd public/3rd-party/Fork-Awesome-1.2.0/src/doc

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation