Web Page Gehirn Research Group

Important

This README is under construction, any further fix need to be approved by Team Leads

Why is this project being made?

This project serves as a pivotal initiative for our esteemed Research Group. With a definitive goal in mind, we aim to enhance our online presence by undertaking a comprehensive revamp of our existing website and blog. The primary objective is to execute a strategic and progressive development approach, phased to align with the evolving needs and advancements in the digital landscape.

Content

• Getting Started
• Characteristics
• Commits
• Technologies
• Usage
• Team
• Troubleshooting
• Recommended Pre-Configuration
• License

Getting Started

Tip

Before getting started checkout Recommended Pre-Configuration for avoid any problems.

Follow these steps to get the project up and running on your local machine:

1. Clone repository:

   • By using HTTPS:

     git clone https://github.com/WebDevelopmentGehirn/MainWebPage.git
     cd MainWebPage

   • Or using SSH:

     git clone git@github.com:WebDevelopmentGehirn/MainWebPage.git
     cd MainWebPage

2. Move into Developer Branches:

   To start developing in this project, you need to be inside a Developer Branch [feature/my-feature]. Then you can merge your changes into the dev branch.

     git checkout feature/my-feature

3. Install packages:

     npm install

4. Execute:

     npm run dev

5. Test:

   Go to your localhost:3000 to test if the web-app is working well.

Any Issues? Go to Troubleshooting for common error logs.

Characteristics

• Basic landing page for Gehirn Research Group
• Active Development Projects
• CTA for interested viewers
• Links to our webs

Commits

Description	Type	Format	Example
Requirements and Features	feat	:sparkles:	feat: ✨ Include new feature
Change Control	feat	:boom:	feat: 💥 Service implementation
Defects and Incidents	fix	:construction:	fix: 🚧 Mapping is corrected
Fix bugs	fix	:bug:	fix: 🐛 Mapping order fix
Immediate correction is required	fix	:ambulance:	fix: 🚑 Fix flow bug
Phase or sprint implemented	feat	:package:	feat: 📦 Feature is included
Add, update or pass tests	test	:white_check_mark:	test: ✅ New tests added
Add or update documentation	docs	:memo:	docs: 📝 Update doc
Add or update UI styles	style	:lipstick:	style: 💄 Update UI
Write bad code needed review	refactor	:poop:	refactor: 💩 Fix this please
Remove files	feat	:fire:	feat: 🔥 Remove file
Reverting changes	revert	:rewind:	revert: ⏪ I shouldn't do that again
Improving Performance	perf	:zap:	perf: ⚡ Optimizing code

Technologies

This project is built using Nuxt.js, a Vue.js framework that enables the creation of server-side rendered (SSR) and static web applications with the objective of simplify the development process by providing our developers a higher-level framework with conventions and best practices, allowing us to focus on building robust and scalable applications.

Key Features

• Server-Side Rendering (SSR): Nuxt.js enables SSR out of the box, improving SEO and performance by rendering pages on the server before sending them to the client.

• Vue.js Integration: Leveraging the Vue.js framework, Nuxt provides a structured and organized approach to building Vue applications, making it easy to create dynamic and interactive user interfaces.

• Automatic Routing: Nuxt.js automatically generates routes based on the file structure in the pages directory, reducing the need for manual route configuration.

• VueX State Management: The project incorporates VueX for state management, allowing for centralized state management and easy synchronization between components.

• Plugin System: Nuxt.js has a flexible plugin system that simplifies the integration of third-party libraries and tools, enhancing extensibility.

• Middleware: Middleware in Nuxt.js allows for custom functions to be run before rendering a page or layout, providing control over the middleware stack.

Usage

Note

Team Members are allowed to make User Manuals for this Section.

Here we'll put some UX stuff.

Team

Are you contributing? Put something here!

Troubleshooting

Recommended Pre-Configuration

Go back to: Getting Started.

• SSH-Key for cloning:

Quick guide for SSH configuration
1. Use ssh-keygen command for generate your key in directory [~/.ssh] with the name you want (Default name: id_rsa).
2. Go to [Settings >> Access >> SSH and GPG keys] in your GitHub.
3. Click on New SSH key and copy the content of your id_rsa.pub into Key textfield, fill Title and select a Key type, then click on Add SSH key.

• NVM for Node and NPM version:

Quick guide for NVM installation
Linux or Unix Systems
1. Go to NVM Installation guide and copy the curl command for installation in your terminal, then confirm the installation using nvm -v command and you should see the version installed.
2. Use nvm install with your desire version (In this case LTS(20.11.1)) e.g.nvm install 20.
3. Use nvm use with your desire version to activate your node and npm version.
Windows Systems
1. Go to NVM for Windows, download nvm-setup.exe and follow the Wizard Installation, then confirm the installation using nvm -v command and you should see the version installed.
2. Use nvm install with your desire version (In this case LTS(20.11.1)) e.g.nvm install 20.
3. Use nvm use with your desire version to activate your node and npm version.

License

License