AmericaSCORESBayArea / student-registration

Student families need to easily access their records and waivers at least once per year. This service needs to be paper-free, secure, and reliable... and a future standard for school districts and youth-focused nonprofits/volunteer organizations. Interfaces with Mulesoft API's and Salesforce.
https://scoresu.org
Other
2 stars 0 forks source link

Documentation on how to run Student Web Registration #254

Open supraj-gunda opened 5 months ago

supraj-gunda commented 5 months ago

Description (by @AleksandrMolchagin):

Create comprehensive documentation on how to run the Student Web Registration system. This documentation should include installation steps, prerequisites, configuration details, and instructions for running the application locally.

Refer to the following example: https://github.com/AmericaSCORESBayArea/salesforce-data-api/blob/master/README.md


notes by @supraj-gunda

Currently, to successfully run the student web registration site (master version), we must:

Add this code on line 42 of the package.json file: “start”: “react-scripts start”, Replace the placeholder code in the .env file with the actual information Navigate to the repository in terminal and run the following commands: npm install --force npm install react-flags-select --force

If we clone the debug version of the github repository instead, we can skip the step of filling out the .env file.

To do:

  1. push the start code to the debug version of the code in github
  2. fix the versions of the dependencies used in the code (what dependencies are compatible and necessary for program compilation), so that you don't have to --force away dependency warnings