Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

ost-cas-fee-adv-22-23/app-lobsome

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🐼 Mumble App by Team LOBSOME 🐼

In this project, we implemented the Mumble Design System. Throughout the project, we worked collaboratively to achieve a clean, fast and maintainable code. By the end of the project, we hope to have gained a deeper understanding of the architecture around NextJS, as well as developed important skills that will serve us well in future academic and professional pursuits.

We look forward to sharing our findings and experiences with our classmates and instructors, and to learning from their projects as well. Thanks for checking out our Project!


You can find the deployed and ready to use app here:

✈️ Getting Started

Instructions on how to set up and install the project on a local machine.

Installing

Step-by-step instructions on how to set up the project.

To use this library you need to add an .npmrc file with an auth-token

@smartive-education:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken={auth-token}
npm install

After successful installation you can use one of the following commands:

npm run dev - Runs next dev to start Next.js in development mode
npm run build - Runs next build to build the application for production usage
npm run start - Runs next start to start a Next.js production server
npm run lint - Runs next lint to set up Next.js' built-in ESLint configuration

After successful build and start you should be able to access the app on your browser at:

url: http://localhost:3000


🔒 Authentication

To access the content of mumble you need to setup an account at Zitadel.

After successful registration you should be able to login via http://localhost:3000/login.


🛠️ Libraries and Tools

Conventional Commits

We use Conventional Commits for consistent commit messages.

  • The commit message should be structured as follows:
<type>[(scope)]: <description>

For Example:

feat(button): added hover and action styling for button

next-translate

The main goal of next-translate is to keep the translations as simple as possible in a Next.js environment.

Next-translate has two parts: Next.js plugin + i18n API.

TanStack Query

TanStack Query (FKA React Query) is often described as the missing data-fetching library for web applications, but in more technical terms, it makes fetching, caching, synchronizing and updating server state in your web applications a breeze.


⚙️ Dev Ops

Security

ZITADEL gives developers all they need to integrate identity management. Easy as pie. Ready when you are — because serverless. At yours or ours — because open source.

Testing

Playwright enables reliable end-to-end testing for modern web apps.

npm run test:e2e - Running all tests

Jest is a delightful JavaScript Testing Framework with a focus on simplicity.

npm run test - Run watch mode
npm run test:ci - Runs in a CI environment

Docker

To build Mumble as a Docker image locally, you need a local .npmrc file with the credentials for the Smartive Github Organisation credentials. $docker build -t app-lobsome . --secret id=npm,src=.npmrc


👨🏻‍💻 Authors