LMSMirror

LMSMirror is a free and open-source client of LMS (Blackboard).

Table of Contents

Table of Contents

1. Development Stack
2. Getting Started
   • Prerequisites
   • Development
3. Roadmap
4. Contributions
5. Resources

Development Stack

• 
• 
• 
• 

Getting Started

Prerequisites

1. Install NodeJS
2. Install Git
3. Clone the project

git clone https://github.com/Bowserinator/LMSMirror

5. Install the needed dependencies and move to the frontend folder

npm install && cd frontend

Development

# serve with hot reload at localhost:3000
npm run dev

# build for production and launch server
npm run build
npm run start

# generate static project
npm run generate

# prettier formatting
npm run pretty

# prettier lint check
npm run linting

Contributions

1. Create a branch

git checkout -b branch-name

2. Switch to the recently created branch

git checkout branch-name

3. Change the files that are needed
4. Add your changes to staging

git add .

5. Commit your files to staging

git commit -m "commit message"

6. Connect your branch to the repo and push up

git push -u origin branch-name

7. Update your local repository with current remote repository

git pull

Roadmap

Refer to our Wiki

Resources

• Vue Documentation
• Nuxt Documentation
• SASS Documentation
• Git Tutorial
• Markdown Badges