Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/superwalnut/odyssey
https://github.com/superwalnut/odyssey
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/superwalnut/odyssey
- Owner: superwalnut
- License: apache-2.0
- Created: 2022-05-30T00:47:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-23T05:08:31.000Z (6 months ago)
- Last Synced: 2024-07-23T07:16:52.653Z (6 months ago)
- Language: TypeScript
- Size: 62.7 MB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# odyssey
## Technology Stack
- [Angular 11](https://easybase.io/react-and-react-native-user-authentication/)
- [Firebase](https://easybase.io/react-database-app-tutorial/)
- [CoreUI](https://coreui.io/angular/)
#### Prerequisites
Before you begin, make sure your development environment includes `Node.js®` and an `npm` package manager.
```bash
Git clone https://github.com/superwalnut/hbc-secrets.git
```
1. Copy .env to Odssey root folder
2. Copy local.environment.ts to Odssey src/environments folder
both files are added to .gitignore
## Debug Locally
- make sure you have the .env file contains all required secrets. (https://github.com/superwalnut/hbc-secrets)
- also copy the local.environment.ts to environment folder for local debug (https://github.com/superwalnut/hbc-secrets)
- npm run start or ng serve
## Build & Deploy
Try to avoid run command: npm run config.
When you run npm run config, it will run set-env.ts to override the environment.prod.ts file, that will populate all the secrets from your .env (environment variables).
If you did run that, no big deal. Just please ignore all the changes to environment.ts or environment.prod.ts files.
## Build pipeline
Need to create PR to merge to main.
Once merged, it will deploy the main branch code to uat.
For production deployment, it requires approval.
#### Strategy 1
- 1. Clone the repo [main]
- 2. Create a feature branch to work on
- 3. Push the feature branch
- 4. Create a Pull Request to merge to main (trigger a UAT build)
- 5. Logon to Github to approve and merge to main
- 6. Feel free to delete the feature branch
- 7. Go to the successful UAT build and click to request for approval for production build
#### Strategy 2
- 1. Fork it to your own Repo
- 2. Create a local branch to work on or work directly in your main
- 3. Create a Pull request to the original repo for PR approval
## Getting Started
```bash
# serve with hot reload at localhost:4200.
$ ng serve
# build for production with minification
$ ng build
```
```
free-angular-admin-template/
├── e2e/
├── src/
│ ├── app/
│ ├── assets/
│ ├── environments/
│ ├── scss/
│ ├── index.html
│ └── ...
├── .angular-cli.json
├── ...
├── package.json
└── ...
```
```
npm install
```
## Add new component
ng g c views/[name] --module=app.module
## Firebase deployment
```
firebase login
firebase init
Specify your site in firebase.json
{
"hosting": {
"site": "hbclub",
"public": "public",
...
}
}
```
When you're ready, deploy your web app
firebase deploy --only hosting:hbclub
visit: https://hbclub-919aa.web.app/
## New Angular/NPM version, run this
npm install --legacy-peer-deps
##### Update to Angular 11
Angular 11 requires `Node.js` version 10.13 or newer
Update guide - see: [https://update.angular.io](https://update.angular.io)
fork test