Skip to content

Files

Latest commit

tctien342tctien342
feat(base): stable base for using across projects
Aug 9, 2024
92afe02 · Aug 9, 2024

History

History
62 lines (42 loc) · 1.76 KB

README.md

File metadata and controls

62 lines (42 loc) · 1.76 KB

NTR Tempalte

This is a web application template built with Next.js, tRPC, TailwindCSS, Eslint, MilionJS and Bun.js.

Technologies Used

This web application template is built with the following technologies:

  • React: A JavaScript library for building user interfaces.
  • MilionJS: A minimal, fast react compiler.
  • Next.js: A React framework for building JavaScript applications.
  • tRPC: A framework for building typesafe APIs.
  • Bun.js: A minimal, fast JavaScript runtime.
  • Tailwind CSS: A utility-first CSS framework for building custom designs.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • NodeJS, at least 18.x.x
  • BunJS

Installation

  1. Clone the repo 
    git clone https://github.com/tctien342/ntr-template.git
  2. Install NPM packages 
    bun install
  3. Start the development server 
    bun run dev

Usage

After starting the development server, you can view the application in your web browser at http://localhost:3000.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Tran Cong Tien - [email protected]

Project Link: https://github.com/tctien342/ntr-template