Skip to content

MASL-FUTMinna/medlink-client

Repository files navigation

This is a Next.js project bootstrapped with create-next-app.

Getting Started

Prerequisites

To run this project you need the following installed:

Setup

Clone this repository to your desired folder:

git clone https://github.com/Superfly101/medlink.git

Install project dependencies:

cd medlink
pnpm install

Run development server:

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

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

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Contribution Guidelines

  1. Clone the repo git clone https://github.com/Superfly101/medlink.git.
  2. Create a new branch from the dev branch git checkout -b Feat/{feature you're working on}
  3. Make sure your branch is up to date with the dev branch: git pull origin dev
  4. After making changes, do git add .
  5. Commit your changes with a descriptive commit message: git commit -m "your commit message".
  6. To make sure there are no conflicts, run git pull origin dev.
  7. Push changes to your new branch, run git push -u origin Feat/{feature you're working on}.
  8. Create a pull request to the dev branch not main.
  9. Ensure to describe your pull request.

Commit CheatSheet

Type Description
feat Features A new feature you're adding
fix Bug Fixes A bug fix
docs Documentation Documentation only changes
style Styles Features and updates relating to styling
refactor Code Refactoring A code change that neither fixes a bug nor adds a feature
perf Performance Improvements A code change that improves performance
test Tests Adding missing tests or correcting existing tests
build Builds Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci Continuous Integrations Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
chore Chores Other changes that don't modify, frontend or test files
revert Reverts Reverts a previous commit

Sample Commit Messages

  • feat: Added plugin info endpoints := feat is used here because the feature was non-existent before the commit.

Releases

No releases published

Packages

 
 
 

Contributors

Languages