Reach LMS Frontend

Deployed link: https://a.reachlms.dev

Contributors

Chaz Kiker	Christopher Girven	Simone Ballard	Sebastian Mendoza	David Chang	Rhea Manuel
Alden Ho	Ashton Turner	Bhawnish Kumar	Joel Vega

Getting Started

• Fork and clone the repo to install it as your own remote.
  • note please be sure to set your remote for this repo to point to your Labs Team Front End Repository.
• run: npm install to download all dependencies.
• run: npm start to start your local development server.

When using Okta for authentication, the app will need to run locally on port 3000.

Key Features

• Mobile First: the application is highly responsive to different screen sizes and also supports larger screens.
• User Roles: Each user has one of three roles: admin, teacher, or student. Each role has a specific set of features available once inside the app.
• User Profiles: Each user can view and update their own user profile once inside the app.
• Program Management: Admins can create a program once inside the app and can update and delete that program as well.
• Curriculum Management: Admins can create, update, and delete courses per program, as well as modules per course.
• Dropdown menus in UI for students to more easily manage their modules.

Front End deployed to AWS

Back End deployed to Heroku

Authentication and Security with Okta

Installation Instructions

Run npm i and npm start in the main folder to run on localhost:3000. Project is already deployed with AWS here: https://a.reachlms.dev

Other Scripts

  - build - creates a build of the application
  - start - starts the production server after a build is created
  - test - runs tests in **tests** directory \* eject - copy the configuration files and dependencies into the project so you have full control over them

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Documentation

See this repository's Wiki for further details

See Backend GitHub Wiki for details on the backend of our project.