kbventures / next-mtrade-pr-automation-workflow

Pr Automation Work Flow Using Github Actions

mTrade

Mindful Analysis Of Your Trades!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Design
2. Getting Started
   • Prerequisites
   • Getting started
3. What I have learned
4. What issues have I faced and how I resolved them
5. Roadmap
6. Contributing
7. File Structure
8. Linting
9. License
10. Contact

About The Project

(back to top)

MTrade is a crypto exchange trade analysis web application which enables users with crypto exchange API keys to obtain select data from their account, obtain a mindful analysis and easy to understand data visualisations.

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Design

(back to top)

Getting Started

This is an example of how you go about setting up our project locally. To get a local copy up and run follow these simple example steps.

Prerequisites

• Node.js: Download
• Git: Download

Installation

1. Clone the repo

   git clone https://github.com/kbventures/next-mtrade.git

2. Go to cloned folder

   cd next-mtrade

3. Install NPM packages

   npm install

4. Add .env file inside server directory

   JWT_SECRET="secret"
   NEXTAUTH_URL="http://localhost:3000/"
   DATABASE_URL="file:./dev.db"

Running

1. Start App

   npm run dev

2. Go to http://localhost:300/ if you wanna see client

(back to top)

Run Unit Tests

1. Terminal

   npm run test

(back to top)

Production build

1. Terminal

npm run build

(back to top)

Rung production build

1. Terminal

npm run start

(back to top)

What I have learned

1. Settin up unit, intergration& e2e tests
2. Postgresql using a object relationnal maper Prisma.
3. Next.js advanced concept like Edge runtime
4. Typescript
5. Internationalization with next-i18-next
6. Authentication with next-auth

What issues have I faced and how I resolved them

Example:

Roadmap

• MVP
  • [ ]
  • [ ]

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

How Do I Contribute Using Git?

1. Clone the repository with this command if you don't have it:

   git clone https://github.com/kbventures/next-mtrade

2. Run the following command to make sure you have the latest changes on the main branch

   git pull

3. Create a new feature branch with a descriptive name and only make your changes here. For example, to add this README documentation I would call this branch add-git-workflow.

   git checkout -b <your feature branch name>

4. Make as many changes as you need in your feature branch. You can use the following commands per commit message.

   git add .
   git status
   git commit -m <your commit message>

5. Once your feature is ready and you're ready to merge into the main branch first make sure to push your local branch changes to GitHub's computers.

   git push --set-upstream origin <your feature branch name>

6. Go to https://github.com/kbventures/ecommerce/branches and you should see your newly pushed feature branch. Find and click the button "New pull request" to request for your changes to be "pulled" into the main branch.

7. When you click the button, complete the form required for each pull request and click "Create pull request".

8. In the top-right corner click "Reviewers" and add one person on the team as a reviewer for the pull request.

9. Once the Reviewer has looked at your pull request and verified everything is OK, they will merge your pull request into the main branch.

What if I have a Conflict?

1. From within your feature branch, fetch the latest changes from the main branch

   git fetch origin main

2. Rebase so that your feature branch history is stacked on top of the latest main branch history

   git rebase origin/main

3. Now resolve the conflicts manually in your code editor one at a time. Git will tell you which files have a conflict. Once you've resolved the conflicts run the following commands:

   git add .
   git rebase --continue

4. Write and save a commit message if all conflicts are resolved.

5. Push your rebased feature branch changes to GitHub's computers.

   git push -f origin <your feature branch name>

6. Go back to your pull request on Github your pull request should have no conflicts and you can merge into the main branch!

Also, don't forget the most important rule of rebasing:

NEVER REBASE ON A REMOTE BRANCH >

How Do I Write Good Commit Message?

Why do we care to write a good commit message? A well-crafted Git commit message is the best way to communicate context about a change to other developers working on that project, and indeed, to your future self.

A commit has two parts: a subject (max 50 characters) and a description. Use the following command to separate a subject from the description.

git commit -m "Subject" -m "Description..."

In each commit message:

1. Specify the type of commit in the subject. Example: Feat: create landing page.

   • feat: The new feature you're adding to a particular application
   • fix: A bug fix
   • style: Feature and updates related to styling
   • refactor: Refactoring a specific section of the codebase
   • test: Everything related to testing
   • docs: Everything related to documentation
   • chore: Regular code maintenance.

2. Separate the subject from the body

3. Remove whitespace errors

4. Remove unnecessary punctuation marks

5. Do not end the subject line with a period

6. Capitalize the subject line and each paragraph

7. Use the body to explain what changes you have made and why you made them.

8. Do not assume the reviewer understands what the original problem was, ensure you add it.

9. Do not think your code is self-explanatory

(back to top)

File Structure

We are grouping by feature as listed in React docs. See Grouping by features or routes

(back to top)

Linting

We are using ESLint with Airbnb rules, alongside Prettier to format code and follow modern standarts when writhing Javascript In addition, we can minimize runtime errors.

(back to top)

PRE-COMMIT

PRE-PUSH

We are using husky to use create git hooks to run linting pre-commit and automated tests pre-push that will stop the respective git command if the checks fail.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Ken Beaudin - @kb9700

(back to top)