Jeff Liu commited on
Commit
a291c56
β€’
0 Parent(s):

Initial commit

Browse files
Files changed (2) hide show
  1. .gitignore +1 -0
  2. README.md +66 -0
.gitignore ADDED
@@ -0,0 +1 @@
 
 
1
+
README.md ADDED
@@ -0,0 +1,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # πŸ‘©πŸΎβ€πŸ’» Project Starter Template
2
+
3
+ [Project Description]
4
+
5
+ ## Designs
6
+ [Screenshot description]
7
+
8
+ [Link to the project Figma](https://apple.com)
9
+
10
+ [2-4 screenshots from the app]
11
+
12
+ ## Architecture
13
+ ### Tech Stack πŸ₯ž
14
+ The app is built using [tech stack]
15
+
16
+ [Description of any notable added services]
17
+
18
+ [Link to other repos that comprise the project (optional)](https://github.com/)
19
+
20
+ #### Packages πŸ“¦
21
+ * [List of notable packages with links]
22
+
23
+ ### Style
24
+ [Describe notable code style conventions]
25
+
26
+ 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)]
27
+
28
+ ### Data Models
29
+ [Brief description of typical data models.]
30
+
31
+ [Detailed description should be moved to the repo's Wiki page]
32
+
33
+ ### File Structure
34
+
35
+ ```
36
+ β”œβ”€β”€[Top Level]/ # root directory
37
+ | └──[File] # brief description of file
38
+ | └──[Folder1]/ # brief description of folder
39
+ | └──[Folder2]/ # brief description of folder
40
+ [etc...]
41
+ ```
42
+
43
+ For more detailed documentation on our file structure and specific functions in the code, feel free to check the project files themselves.
44
+
45
+ ## Setup Steps (example)
46
+ 1. Clone repo by running `git clone https://github.com/dali-lab/<REPONAME>.git` in your terminal and `cd <REPONAME>`
47
+ 2. Run [`npm install` or equivalent] to install all of the necessary packages
48
+ * 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>
49
+ 3. Make sure you have [package names] installed. You can install it by running `npm install <PACKAGE NAMES IF NECESSARY> <--global IF NECESSARY>`
50
+ 4. To start the app locally, run [`npm start` or the relevant start command].
51
+
52
+ ## Deployment πŸš€
53
+ [Where is the app deployed? i.e. Expo, Surge, TestFlight etc.]
54
+
55
+ [What are the steps to re-deploy the project with any new changes?]
56
+
57
+ [How does one get access to the deployed project?]
58
+
59
+ ## Authors
60
+ * Firstname Lastname 'YY, role
61
+
62
+ ## Acknowledgments 🀝
63
+ We would like to thank [anyone you would like to acknowledge] for [what you would like to acknowledge them for].
64
+
65
+ ---
66
+ Designed and developed by [@DALI Lab](https://github.com/dali-lab)