Skip to content

dali-lab/wisp25

Repository files navigation

👩🏾‍💻 Big Green Planner - WISP 25 Project

[Project Description]

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.

Designs

[Screenshot description]

Link to the project Figma

[2-4 screenshots from the app]

Architecture

Tech Stack

Packages 📦

  • [List of notable packages with links]

Style

[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]

Data Models

[Brief description of typical data models.]

[Detailed description should be moved to the repo's Wiki page]

File Structure

├──[Top Level]/                  # root directory
|  └──[File]                     # brief description of file
|  └──[Folder1]/                 # brief description of folder 
|  └──[Folder2]/                 # brief description of folder
[etc...]

For more detailed documentation on our file structure and specific functions in the code, feel free to check the project files themselves.

Available Scripts

In the project directory, you can run:

npm install

Installs project dependencies.

npm start

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.

npm run build

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!

npm run lint

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.

Deployment 🚀

[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?]

Authors

  • Firstname Lastname 'YY, role

Acknowledgments 🤝

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published