Learn Verse Front End Application

LearnVerse is a platform to help publish online courses and enhance the learning journey.

Best Practises to follow

File Structure

• app directory is for the Routes that translate to actual pages in the application.
• components is for all components in the applications.
• services is for data fetching logic.
• hooks is for custom React hooks.
• constants is for shared Global variables.

Naming Conventions

• Variables => Camel Case learnVerse instead of learn_verse
• Constants => ALL upper case LEARNVERSE or LEARN_VERSE
• Components => React components have to start with an upper case letter Header not header
• please use lowercase for all folders or directories in the source code.

Quotes

please use double quotes "learn verse" instead of single ones 'learn verse' you can install The Prettier VS Code plugin to do that automatically Prettier

Useful VS Code Plugins

1. Prettier Prettier
2. Auto Close Tag Auto Close Tag
3. Auto Rename Tag Auto Rename Tag
4. ESLint ESLint
5. ES7+ React/Redux/React-Native snippets React Snippets
6. JavaScript and TypeScript Nightly TypeScript Nightly
7. Tailwind Docs Tailwind
8. Import Cost Import Cost

Arrow Function

for consistency and simplicity always prefer the Arrow function.

const printHello => () => {
  console.log("Hello Learn Verse");
};

instead of

function printHello() {
  console.log("Hello Learn Verse");
}

Default Export

Outside the app directory don't use default exports.

export const printHello => () => {
  console.log("Hello Learn Verse");
};

instead of

const printHello => () => {
  console.log("Hello Learn Verse");
};

export default printHello;

Variable Declarations

DO NOT use var! ❌❌❌

var title = "Learn Verse";

• Prefer using const whenever possible unless the variable needs to change, in that case use let;

const GRADUATION_YEAR = 2024;

let daysRemaining = 90;

@EveryMorning
daysRemaining = daysRemaining - 1 // or daysRemaining--

Branching and Best Practises

Pushing directly to the master branch is considered risky and bad practice. Thus unless it's a small commit, please create a new branch, make changes, commit changes, push the new branch with the changes and finally open a pull request.

Create a branch

Before creating a new branch, please make sure you are on the master branch.

$ git checkout master
Switched to branch 'master'

Please make sure your local repo has the recent commits,

$ git pull

after that, create a new branch,

hotfix here is the name of the new branch, feel free to name the branch whatever you want.

$ git checkout -b hotfix
Switched to a new branch 'hotfix'

Make all the changes required,

When pushing the code, do the following

Add Command

$ git add .

Commit Command

$ git commit -m "hot fixed done" 

Push Command

$ git push origin hotfix

Merge Pull Requests

Please don't merge your pull requests, Ask another team member to review your code changes and then he can merge it if accepted by the Reviewer.