Ult

Ult: Uniting Nest.js + Prisma + tRPC, Next.js + Tailwind for the ultimate streamlined web development.

Dive into the future of web development with Ult, the perfect blend of Nest.js, Prisma, and tRPC on the server side, paired seamlessly with Next.js and Tailwind CSS on the client side. Experience effortless back-end to front-end integration, rapid development cycles, and a modern, stylish UI with minimal code. Ult is your one-stop solution for building scalable, efficient, and visually stunning web applications. Get ready to elevate your projects to the next level with ease and sophistication.

Getting Started

Requirements

Ensure you have the following dependencies installed on your system:

TypeScript
Pnpm
Docker Compose

Installation

Clone the Ult repository:

git clone https://github.com/jaequery/ult

Change to the project directory:

cd ult

Install the dependencies:

pnpm install

Setup

Run Postgres database using Docker that will listen on port 5432:

docker-compose up -d

Create ./apps/server/.env.development

cd ./apps/server
cp .env.example .env.development

Database should work out of the box with the default credentials for local development. But for email, you will need a valid SMTP account. You can get it free at brevo.com.

Run db migration to create the database tables

pnpm db:migrate

Run the db seed to populate the database with initial data

pnpm db:seed

Running development environment

Use the following command to run both Nest and Next server.

pnpm dev

This will start the Next.js server on http://localhost:3000 and the Nest.js on http://localhost:3001.

Tests

Use the following command to run tests:

pnpm test

Contributing

Contributions are welcome! Here are several ways you can contribute:

Submit Pull Requests: Review open PRs, and submit your own PRs.
Join the Discussions: Share your insights, provide feedback, or ask questions.
Report Issues: Submit bugs found or log feature requests for the ultima project.

Contributing Guidelines

Fork the Repository: Start by forking the project repository to your github account.
Clone Locally: Clone the forked repository to your local machine using a git client.
```
git clone https://github.com/jaequery/ult
```
Create a New Branch: Always work on a new branch, giving it a descriptive name.
```
git checkout -b new-feature-x
```
Make Your Changes: Develop and test your changes locally.
Commit Your Changes: Commit with a clear message describing your updates.
```
git commit -m 'Implemented new feature x.'
```
Push to GitHub: Push the changes to your forked repository.
```
git push origin new-feature-x
```
Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.

License

This project is protected under the MIT License. For more details, refer to the LICENSE file.

Acknowledgments

List any resources, contributors, inspiration, etc. here.

Return

uptownhr / Ult

Ult