Skip to content

Latest commit

 

History

History
123 lines (85 loc) · 5.92 KB

README.md

File metadata and controls

123 lines (85 loc) · 5.92 KB
Raw

rasnage

Biome Bun Next.js React Tailwind CSS TypeScript VSCode Dev Container License

New Raspberry Pi Signage System🦏

📃 Usage

To clone and run this application, you'll need Git and Bun installed on your computer.
From your command line:

# Clone this repository
$ git clone https://github.com/OpenUp-LabTakizawa/rasnage

# Install dependencies with bun
$ cd rasnage && bun i

# Develop the app
$ bun dev

# Test the app
$ bun test:app

# E2E Test
$ bun test:e2e

# Build the app
$ bun run build

# Start the app
$ bun start

# Format and Lint the files
$ bun lint

🆚 VSCode

Visual Studio Code is the recommended IDE for working on this project, as it has been configured.

Once opening, you can run Extensions: Show Recommended Extensions to install the recommended extensions for good development is automatically configured.

🐳 Dev Containers

A dev container is a running container with a well-defined tool/runtime stack and its prerequisites.
You can try out dev containers with GitHub Codespaces or Visual Studio Code Dev Containers.

Setting up the dev container

GitHub Codespaces

Follow these steps to open this project in a Codespace:

  1. Click the Code drop-down menu.
  2. Click on the Codespaces tab.
  3. Click Create codespace on main.

For more info, check out the GitHub documentation.

VSCode Dev Containers

If you already have VSCode and Docker installed, you can click the badge above or here to get started.
Clicking these links will cause VSCode to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.

Follow these steps to open this project in a container using the VSCode Dev Containers extension:

  1. If this is your first time using a dev container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the getting started steps.

  2. To use this repository, open a locally cloned copy of the code:

    • Clone this repository to your local filesystem.
    • Press F1 and select the Dev Containers: Open Folder in Container... command.
    • Select the cloned copy of this folder, wait for the container to start, and try things out!

🫶 Contribute

Want to report a bug, contribute some code, or improve the documentation? Excellent!
Read up on our guidelines for contributing and Code of Conduct.
Then check out one of our issues labeled as 😵‍💫help wanted or good first issue.

📦 Credits

This software uses the following open source packages:

⚖️ License

FOSSA Status

The Apache License Version 2.0 (2023) - OpenUp-LabTakizawa.
Please have a look at the LICENSE for more details.