This repository is an optional frontend starter for new DALI React projects. Installation and setup instructions are included below. You should eventually customize this README file with project-specific documentation.
[Screenshot description]
[2-4 screenshots from the app]
- [Description of any notable added services]
[Describe notable code style conventions]
We are using [typically a configuration like CS52's React-Native ESLint Configuration or CS52's ES6 and Node ESLint Configuration]
.
├── ...
├── public
├── src
│ └── api # React Query server state cache
│ └── assets # static assets
│ └── components # reusable components across several screens
│ └── screens # individual pages
│ └── store # Zustand client state
│ └── types # TS types
│ └── utils # utility folder containing helper files
├── tsconfig.json # TypeScript configuration
├── package.json # npm config
└── ...
For more detailed documentation on our file structure and specific functions in the code, feel free to check the project files themselves.
In the project directory, you can run:
Installs project dependencies.
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
ESLint is set up in this project. To keep code clean, always remember to run npm run lint
and fix any lint problems before merging into master.
[Where is the app deployed? i.e. Expo, Surge, TestFlight etc.]
[What are the steps to re-deploy the project with any new changes?]
[How does one get access to the deployed project?]
- Firstname Lastname 'YY, role
We would like to thank [anyone you would like to acknowledge] for [what you would like to acknowledge them for].
Designed and developed by @DALI Lab
- Eric Lu '25
Additional credit goes to Adam McQuilkin '22, Thomas Monfre '21, Tyler Vergho '23 for developing the original DALI CRUD Template Frontend, which this starter pack was evolved from.