Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ynigoreyes/hackwestx-web-app
Web App for the Hackathon
https://github.com/ynigoreyes/hackwestx-web-app
Last synced: 6 days ago
JSON representation
Web App for the Hackathon
- Host: GitHub
- URL: https://github.com/ynigoreyes/hackwestx-web-app
- Owner: ynigoreyes
- Created: 2018-07-13T22:06:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-07-25T22:07:39.000Z (over 6 years ago)
- Last Synced: 2024-12-15T23:41:40.931Z (2 months ago)
- Language: TypeScript
- Size: 893 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HackWesTx Web App
#### Tech Stack
* React-Typescript
* Semantic UI
* Firebase
* Functions
* Hosting
* Yarn v1.7
* TSLint
* Jest
* NodeJS v10.4.1
#### Contributing
* Must be able to login to Firebase
* Install Yarn
You can use npm, but there maybe some issues as there are differences in installation
```
// Mac OS
$ brew install yarn
// Debian/Ubuntu
$ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
$ echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
// then...
$ sudo apt-get update && sudo apt-get install yarn
// Windows
```
For Windows installation, visit their [website](https://yarnpkg.com/lang/en/docs/install/#windows-stable)
* Install dependencies for functions and source code
```
// Assuming you already have Node v10.4.1 or above
$ yarn install --without-node
$ cd functions && yarn install --without-node
```
* Install Firebase tooling and login to Firebase
```
$ yarn global add firebase-tools@^3.19.3
$ firebase login
```
* Run test suite
```
$ yarn test
```
* Get started by editting files in the src folder. File structure is based off Angular
```
/src
/--components/
/ --Header
/ --Footer
/
/--pages/
/ --HomePage/
/ --components
/ {*child components*}
/ Home.spec.tsx
/ Home.scss
/ Home.tsx
/
/ --OtherPage/
/ --components
/ {*child components*}
/ Other.spec.tsx
/ Other.scss
/ Other.tsx
/
/ Layout.tsx
/
/--redux/
/ --reducers.tsx
/ --store.tsx
/ --actions.tsx
/
/--services/
/ --{*http/state*}
/
/index.tsx {*or App.tsx*}
$ yarn start
```
To deploy, ssh into EC2 instance, log into Google Cloud - Container Builder and run
```
$ gcloud auth login
$ gcloud config set project [PROJECT_ID]
$ gcloud auth configure-docker
$ sudo docker stack deploy --with-registry-auth -c docker-compose.yml acm
```