sikessem / legacy

:globe_with_meridians: Sikessem Labs

Sikessem

The Sikessem Website.

🔖 Contents

• Sikessem Website
  • 🔖 Contents
  • 🎉 Getting Started
    • ⚡️ Installation
    • 🗃️ Manage Database
    • 🌐 Starting server
    • 🧪 Testing and debugging
      • 🧹 Keep a modern codebase
      • ⚗️ Run static analysis
      • ✅ Run unit tests
      • 🐛 Check all code bugs
  • 📋 Requirements
  • 📖 Documentation
  • 👏 Contribution
    • 👷 Code of Conduct
    • 👥 Contributing Guide
    • 🔒️ Good First Issues
    • 💬 Discussions
  • 🔐 Security Reports
  • 📄 License

---

🎉 Getting Started

Installation

Install dependencies:

bun install

Environment

Make and link the .env file:

make env

Project Structure

Inside your project, you'll see the following directory structure:

├── app/
│   ├── assets/
│   │   ├── ...
│   │   errors/
│   │   ├── ...
│   │   routes/
│   │   └── ...
└── lib/
    └── ...

• app/routes: Provides the directory-based routing, which can include a hierarchy of layout.tsx layout files, and an index.tsx file as the page. Additionally, index.ts files are endpoints. Please see the routing docs for more info.

• app/errors: Recommended directory for errors.

• app/assets: Any static assets, like images, can be placed in the public directory. Please see the Vite public directory for more info.

Add Integrations and deployment

Use the bun qwik add command to add additional integrations. Some examples of integrations includes: Cloudflare, Netlify or Express Server, and the Static Site Generator (SSG).

bun qwik add

Development

Development mode uses Vite's development server. The dev command will server-side render (SSR) the output during development.

bun start

Note: during dev mode, Vite may request a significant number of .js files. This does not represent a Qwik production build.

Preview

The preview command will create a production build of the client modules, a production build of src/entry.preview.tsx, and run a local server. The preview server is only for convenience to preview a production build locally and should not be used as a production server.

bun preview

Production

The production build will generate client and server modules by running both client and server build commands. The build command will use Typescript to run a type check on the source code.

bun run build

🌐 Starting server

This app has a minimal Bun server implementation. After running a full build, you can preview the build using the command:

bun serve

Then visit sikessem.local:3000/

🗃️ Manage Database

[WIP]

🧪 Testing and debugging

🧹 Keep a modern codebase

• with Biome:

bun check

✅ Run unit tests

• using Bun:

bun run test

🚀 Execute end-to-end testing with Playwright:

bun e2e

🐛 Check all code bugs

bun debug

📋 Requirements

• Requires Deno ^1.41 (at least 1.41.0 recommended to avoid potential bugs).
• Requires Bun ^1.0 (at least 1.0.29 recommended to avoid potential bugs).
• Requires Git ~2.43.2 to manage source code.

📖 Documentation

The full documentation for the Sikessem Website can be found on this address.

👏 Contribution

The main purpose of this repository is to continue evolving Sikessem. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Sikessem.

👷 Code of Conduct

Sikessem has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

👥 Contributing Guide

Read our Contributing Guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Sikessem.

🔒️ Good First Issues

We have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

💬 Discussions

Larger discussions and proposals are discussed in Sikessem's GitHub discussions.

🔐 Security Reports

If you discover a security vulnerability within Sikessem, please email SIGUI Kessé Emmanuel at [e-mail]. All security vulnerabilities will be promptly addressed.

📄 License

The Sikessem Website is open-sourced software licensed under the MIT License - see the LICENSE file for details.

---

_{Made with ❤︎ by @siguici.}