search

compilerla / compiler.la

Compiler's website
https://compiler.la
Apache License 2.0
4 stars 2 forks source link

readme

Compiler's website

compiler.la

Deployed via Netlify Netlify Status

Design

We have a Figma file with the current designs, broken into the following sections/pages:

Section Description
🎨 Styleguide Colors, typography, and visual assets
❖ Components Reusable design elements like buttons, navbar, etc.
🏗 Information architecture Mocks of the actual pages, with Flows

We also have 2 Prototypes/Flows that demonstrate navigation and usage of the site:

Flow Description
🏠 Homepage Starting on the homepage https://compiler.la
💼 Jobs Starting on the Jobs listing page https://compiler.la/jobs

Development

Running a local instance

This is a Jekyll static site. Development is done within a container-based environment using VS Code with devcontainers. This repository includes a .devcontainer/devcontainer.json file that configures remote container development.

Once inside the devcontainer in VS Code, you can press Ctrl/Cmd+Shift+B to run the Jekyll: Build Dev task defined in .vscode/tasks.json, which builds the site and starts the Jekyll development server. The site will then be running at http://localhost:4000. Auto rebuild/reload will be active and will watch the site files for changes.

To run the blog in drafts-mode, run Jekyll: Bulid Dev with Drafts

VS Code with devcontainers

Install the Remote - Containers extension

VS Code can be used together with Docker via the Remote - Containers extension to enable a container-based development environment.

Open the repository with VS Code

With the Remote - Containers extension enabled, open the folder containing this repository inside Visual Studio Code.

You should receive a prompt in the Visual Studio Code window; click Reopen in Container to run the development environment inside a container.

If you do not receive a prompt, or when you feel like starting from a fresh environment:

  1. Ctrl/Cmd+Shift+P to bring up the command palette in Visual Studio Code
  2. Type Remote-Containers to filter the commands
  3. Select Rebuild and Reopen in Container

Exiting devcontainers

To close out of the container and re-open the directory locally in Visual Studio Code:

  1. Ctrl/Cmd+Shift+P to bring up the command palette in Visual Studio Code
  2. Type Remote-Containers to filter the commands
  3. Select Reopen Locally