Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .commitlintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default {
extends: ["@solvro/config/commitlint"],
};
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "daily"
allow:
- dependency-name: "@solvro/config"
36 changes: 36 additions & 0 deletions .github/workflows/ci.yml
Comment thread
Rei-x marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: CI

on:
push:
branches: ["main"]
pull_request:

jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup node
uses: actions/setup-node@v4
with:
node-version: 22
cache: "npm"

- name: Install dependencies
run: npm ci

- name: Check commit name
if: github.event_name == 'pull_request'
run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose

- name: Format check
run: npm run format:check
if: always()

- name: Build
run: npm run build
if: always()
1 change: 1 addition & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx commitlint --edit "$1"
1 change: 1 addition & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx lint-staged
111 changes: 91 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,107 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
# Solvro Next.js template

## Getting Started
## Welcome to the repository of Solvro Next.js template

First, run the development server:
A standardized Next.js template maintained by Solvro Science Club at Wrocław University of Science and Technology. This template incorporates our best practices, coding standards, and recommended project structure for web development projects. It serves as a starting point for new Solvro members and projects, ensuring consistency and quality across our initiatives.

## Technologies used

- Next.js
- React.js
- TypeScript
- Tailwind CSS
- Shadcn/ui
- Tanstack Query

## Links

[![docs.solvro.pl](https://i.imgur.com/fuV0gra.png)](https://docs.solvro.pl)

## Development

### 1. Use this template

![Homepage](https://i.imgur.com/RXm10f8.png)

### 2. Install Dependencies

```bash
cd web-template
npm install
```

### 3. Run the Project

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### 5. View the Application

Open your browser and navigate to [http://localhost:3000](http://localhost:3000).

## Working with git

### Github Solvro Handbook

<https://docs.solvro.pl/guides/github>

### SSH

If you are a Windows user, follow this [tutorial](https://www.youtube.com/watch?v=vExsOTgIOGw) to connect via SSH

### Building a new feature

1. Checkout and update main branch

```bash
git checkout main
git pull origin main
git fetch
```

2. Create new feature branch

```bash
git checkout -b feat/x_my_feature_branch
```

> 'x' stands for issue number; this command will create and checkout a new branch named feat/x_my_feature_branch

3. Commit your changes:

```bash
git add .
git commit -m "<description>"
```

4. Push to remote:

```bash
git push origin feat/x_my_feature_branch
```

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
5. Create a Pull Request on GitHub and wait for a review

This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
### ⚠️ Important ⚠️

## Learn More
- Do not push directly to main branch!
- Please remember to commit before checking out to a different branch
- Clean up after a successful merge

To learn more about Next.js, take a look at the following resources:
```bash
git branch -d feat/x_my_feature_branch
git push origin --delete feat/x_my_feature_branch
```

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
## Contact

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
For questions or suggestions, please reach out to us:

## Deploy on Vercel
- ✉️ Email: <kn.solvro@pwr.edu.pl>
- 🌐 Website: [solvro.pwr.edu.pl](https://solvro.pwr.edu.pl/)
- 📘 Facebook: [KN Solvro](https://www.facebook.com/knsolvro)

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
---

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
Thank you for reading! Stay tuned for more updates!
21 changes: 21 additions & 0 deletions components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "new-york",
Comment thread
qamarq marked this conversation as resolved.
"rsc": true,
"tsx": true,
"tailwind": {
"config": "",
"css": "src/app/globals.css",
"baseColor": "gray",
"cssVariables": true,
"prefix": ""
},
"aliases": {
"components": "@/components",
"utils": "@/lib/utils",
"ui": "@/components/ui",
"lib": "@/lib",
"hooks": "@/hooks"
},
"iconLibrary": "lucide"
}
3 changes: 3 additions & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { solvro } from "@solvro/config/eslint";

export default solvro();
16 changes: 0 additions & 16 deletions eslint.config.mjs

This file was deleted.

Loading