Skip to content

Latest commit

 

History

History
92 lines (66 loc) · 3.06 KB

README.md

File metadata and controls

92 lines (66 loc) · 3.06 KB
Raw

NaYud

NaYud is a cutting-edge project leveraging multiple modern technologies for a robust and scalable application. The core tech stack includes Next.js, TypeScript, Bun, and more. With a firm commitment to best practices, the project employs CircleCI for continuous integration, Docker for containerization, Helm charts for orchestration, and semantic versioning to ensure releases are coherent and meaningful.

Table of Contents

  1. Features
  2. Pre-requisites
  3. Getting Started
  4. Contributing
  5. Documentation
  6. License

Features

  • Next.js: An optimized JavaScript framework designed for a smoother developer experience and superior user interface.
  • TypeScript: A superset of JavaScript, offering static types.
  • Bun: An all-in-one JavaScript toolkit.
  • SASS: A powerful pre-processing CSS framework to make your CSS supercharged.
  • CircleCI: A continuous integration tool to ensure code quality and deployment reliability.
  • Docker: A platform used to develop, ship, and run applications inside containers.
  • Helm charts: Orchestration tool to manage Kubernetes applications.
  • Semantic Versioning: Using the principles from semantic-release, we ensure meaningful and coherent releases.
  • ChatGPT Code Review: Leveraging the ChatGPT-CodeReview for automated code reviews.

Pre-requisites

Getting Started

  1. Clone the repository:

    $ git clone https://github.com/dimasyudhatech/client-nayud.git -b master client-nayud

  2. Enter into the project directory:

    $ cd client-nayud

Local Setup

  1. Install dependencies:

    $ bun i

  2. Start the development server:

    $ bun start:dev

Docker Setup

  1. Build the Docker image: 
    $ docker build -t client-nayud:0.0.1 .
  2. Run the container: 
    $ docker run -dit -p 3000:3000 —name client-nayud client-nayud:0.0.1

Contributing

We welcome and appreciate contributions from the community. Please check out our CONTRIBUTING guidelines.

Pull Requests

For adding new features or making changes, submit a pull request.

Issues

Encounter a bug or have a suggestion? Open a new issue.

Documentation

Changelog

To see the list of recent changes, check the changelog.

License

This project is licensed under the terms specified in the LICENSE file.