Penjar is the fastest way to spin up a Full Stack application (React + Node) with Jest testing. Evolution and based off of the Careen stack. Now using TypeScript!
- Navigate to the run_locally directory
- Open terminal of choice in the run_locally directory
- Install your dependencies with
npm install
- Run your application with
npm run start
(Note:start:windows
,start:linux
, andstart:mac
are also available) - Ready to Code!
- Make sure you are on the root directory
- Build the docker image:
docker build -t my-penjar-app-image .
- Run the image as a docker container:
docker run -p 8080:8080 -it --rm --name my-running-penjar-app-container my-penjar-app-image
- Download Draw.io Desktop Edition
- In diagrams folder, open architecture.drawio.png in Draw.io Desktop Edition
- Make changes
- Click save button!
- Note: This command will update dependencies in the following folders: run_locally, back_end, and front_end
- Navigate to the run_locally directory
- Open terminal of choice in the run_locally directory
- Check which dependencies need to be upgraded with
npm run dependup:check
- Upgrade all dependencies with
npm run dependup
- Upgrade dependencies in your package-lock.json with
npm install
- Optional: Check to see which dependencies were not updated (due to failing tests) with
npm run dependup:check
- Navigate to the back_end directory
- Within the "config" directory, add variables that either load in "hard coded values" or "reads from environment variables", which will be used to create the config object
- Optional: Using config object, you can obtain values needed to setup a database client
- Add rest of tests for existing code on the back end