File tree Expand file tree Collapse file tree 1 file changed +29
-23
lines changed Expand file tree Collapse file tree 1 file changed +29
-23
lines changed Original file line number Diff line number Diff line change 1
1
# next-display
2
+ > The front desk TV display webpage.
2
3
3
- ## Project setup
4
- ```
5
- yarn install
6
- ```
4
+ next-display is the webpage shown to visitors and residents of Next House on
5
+ the front desk TV when walking in. It handles announcements from student
6
+ groups and the Exec team and displays the current time, weather, and campus
7
+ shuttle tracking information.
7
8
8
- ### Compiles and hot-reloads for development
9
- ```
10
- yarn run serve
11
- ```
9
+ ## Usage
10
+ See the [ Installation] ( #installation ) instructions on how to initially build
11
+ this project.
12
12
13
- ### Compiles and minifies for production
14
- ```
15
- yarn run build
16
- ```
13
+ Simply place these files in any server path, and these files will be served as
14
+ a static resource. Nothing else is needed for this to work.
17
15
18
- ### Run your tests
19
- ```
20
- yarn run test
21
- ```
22
-
23
- ### Lints and fixes files
24
- ```
25
- yarn run lint
26
- ```
16
+ ## Installation
17
+ Before you proceed further, make sure you have the following dependencies
18
+ installed in order to build this project:
19
+ - [ Node.js] ( https://nodejs.org/en/ )
20
+ - [ Vue CLI] ( https://cli.vuejs.org/ )
21
+ - [ Yarn] ( https://yarnpkg.com/en/ )
27
22
28
- ### Customize configuration
29
- See [ Configuration Reference] ( https://cli.vuejs.org/config/ ) .
23
+ You will need to clone this repository in order to compile all of the assets
24
+ for deployment:
25
+ ``` bash
26
+ git clone
[email protected] :next-exec/next-display.git
27
+ cd next-display/
28
+ ```
29
+ Once this is done, install the dependencies and then run the build command.
30
+ ``` bash
31
+ yarn
32
+ yarn build
33
+ ```
34
+ The build output will be located in ` /dist/ ` . See [ Usage] ( #usage ) on how to
35
+ deploy this.
You can’t perform that action at this time.
0 commit comments