Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edricchan03/studybuddy-web-angular
Source code of the official StudyBuddy web client.
https://github.com/edricchan03/studybuddy-web-angular
angular angular-material angular-material2 firebase study-buddy studybuddy studybuddy-web web-client
Last synced: 15 days ago
JSON representation
Source code of the official StudyBuddy web client.
- Host: GitHub
- URL: https://github.com/edricchan03/studybuddy-web-angular
- Owner: EdricChan03
- License: mit
- Created: 2017-09-22T03:23:24.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-01-24T23:34:11.000Z (about 1 year ago)
- Last Synced: 2024-11-22T06:09:26.041Z (3 months ago)
- Topics: angular, angular-material, angular-material2, firebase, study-buddy, studybuddy, studybuddy-web, web-client
- Language: TypeScript
- Homepage: https://studybuddy.page.link/home
- Size: 3.54 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StudyBuddy-web
This repository contains the source code of the web client, available [here](https://studybuddy-e5f46.web.app).
## Native apps
For a native version of the application, see this [Github repo](https://github.com/EdricChan03/StudyBuddy-android) and its [Releases](https://github.com/EdricChan03/StudyBuddy-android/releases). Note that this is only available for Android for now.
---
## Running a local instance of the site
### Prerequisites
- An installation of the latest [NodeJS](https://nodejs.org/en/) (ideally the version needed for the Angular CLI)
### Get started
To build the source code, follow these steps:
1. Clone this repository locally.
```bash
cd path/to/dir
git clone https://github.com/EdricChan03/StudyBuddy-web
```
2. Install the modules.
```bash
npm i
```
3. Run any one of the commands:
- `npm start`
Serves the app in production mode
- `npm run serveDev`
Serves the app in development mode
4. Navigate to `localhost:4200`.
Done!
---
## Angular CLI Documentation
### Development server
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
### Code scaffolding
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
### Build
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
### Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).