🚀 Project ACM-X

Welcome to the FEU Tech ACM App repository!

This repository contains the FEU Tech ACM Organization's official cross-platform application source code.

The app is being developed to serve as the central platform for communication, collaboration, and promotion of every ACM member and officer in education, opportunities, and beyond.

Tech Stack

• Next.js
• TypeScript
• NextAuth.js
• Prisma
• PostgreSQL
• Tailwind CSS
• tRPC
• ShadcnUI
• PNPM

Development

Pre-requisites

• Git
• PNPM
• Visual Studio Code

Alternatively, you can setup a GitHub Codespace on the project repository.

Getting Started

1. Clone the repository and change directory.

git clone https://github.com/FEUTechACM/acm-app.git acm-app
# or
git clone [email protected]:FEUTechACM/acm-app.git acm-app
# then, change directory
cd acm-app

1. Switch to target branch.

   git checkout <target branch>

2. Install the dependencies.

   pnpm install

3. Run the development server.

   pnpm dev

4. Open http://localhost:3000 with your browser to see the result.

Project Standards

Workflow

For this project, we use the GitHub Flow.

Git Project Rules

1. NEVER rebase the master branch.
2. All feature contributions should be done via pull requests.
3. Only use feat: commit prefix when merging pull requests.
4. Make use of git pull --rebase instead of git pull.
5. Always branch out from master branch.
6. Use only --force-with-lease if in you need to force push.

Commit Rules

We adopt the Conventional Commits specifications aligned with Semantic Versioning with a few modifications.

Commit Message Format

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Note: An (*) asterisk before the commit description indicates that there is more information written in the commit message body.

Commit Message Types

1. fix: a bugfix
2. feat: a new feature (merge commit via pull request only)
3. refactor: a code change that neither fixes a bug nor adds a feature
4. chore: changes to auxiliary tools and libraries (dependencies)
5. style: changes that do not affect the meaning of the code (whitespace, formatting, missing semi-colons, etc)
6. docs: documentation only changes
7. test: adding missing tests or correcting existing tests
8. perf: a code change that improves performance
9. ci: changes to our CI configuration files and scripts
10. build: changes that affect the build tool or external dependencies (example scopes: gulp, broccoli, npm)
11. revert: revert to a commit
12. BREAKING CHANGE: introduces a breaking API change (correlating with Semantic Versioning)

🔗 App Links

1. Web
2. Google Play Store
3. Microsoft Store
4. Huawei App Gallery

👥 Contributors