Child Impact Statements - NestJS Backend
- Ensure the npm dependencies are installed:
npm i. - Create a
.envfile based on the template:
CENSUS_API_KEY=123123123123123123123
NODE_ENV=development
Also note that the Census API key (CENSUS_API_KEY) is optional here.
If you do not have a key or you wish to run the backend without a key,
just omit this line in your .env file.
Additionally, to use a Redis instance for caching, please set the REDIS_URL environment variable,
either in your .env file or passing it in the execution context.
- Start the backend by running either
npm run startornpm run start:dev
To build the server, please run npm run build. The resulting files will be available in dist/.
If you plan to build and run this application for local development, please run npm run start:dev,
otherwise you will have to manually restart the server each time you make a change.
By default, without a membership.json file in src/schools/data, the application service will try and parse
membership.xlsx in src/schools/data, which is available at https://www.tn.gov/content/dam/tn/education/data/membership201920.xlsx.
Note, parsing the Excel spreadsheet in its default form will take a lot of memory and a good bit of time. It is recommended that you shrink the data in the Excel spreadsheet to only include the Shelby Country district.
Once the Excel spreadsheet is parsed, the data is cached in membership.json.