|
--- |
|
title: Barnacle Counter |
|
sdk: gradio |
|
app_file: app.py |
|
pinned: false |
|
--- |
|
|
|
# 👩🏾💻 Project Starter Template |
|
|
|
[Project Description] |
|
|
|
## Designs |
|
[Screenshot description] |
|
|
|
[Link to the project Figma](https://apple.com) |
|
|
|
[2-4 screenshots from the app] |
|
|
|
## Architecture |
|
### Tech Stack 🥞 |
|
The app is built using [tech stack] |
|
|
|
[Description of any notable added services] |
|
|
|
[Link to other repos that comprise the project (optional)](https://github.com/) |
|
|
|
#### 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](https://gist.github.com/timofei7/c8df5cc69f44127afb48f5d1dffb6c84) or [CS52's ES6 and Node ESLint Configuration](https://gist.github.com/timofei7/21ac43d41e506429495c7368f0b40cc7)] |
|
|
|
### 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. |
|
|
|
## Setup Steps (example) |
|
1. Clone repo by running `git clone https://github.com/dali-lab/<REPONAME>.git` in your terminal and `cd <REPONAME>` |
|
2. Run [`npm install` or equivalent] to install all of the necessary packages |
|
* If you don't have [npm or equivalent] installed, you can install it by following the instructions <[here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) OR AT THE RELEVANT HYPERLINK> |
|
3. Make sure you have [package names] installed. You can install it by running `npm install <PACKAGE NAMES IF NECESSARY> <--global IF NECESSARY>` |
|
4. To start the app locally, run [`npm start` or the relevant start command]. |
|
|
|
## 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](https://github.com/dali-lab) |
|
|
