https://github.com/tristan-greffe/feathers-quasar-boilerplate
Starter template combining Feathers.js and Quasar Framework to quickly create web applications
https://github.com/tristan-greffe/feathers-quasar-boilerplate
boilerplate feathers feathersjs js quasar quasar-framework template
Last synced: 5 months ago
JSON representation
Starter template combining Feathers.js and Quasar Framework to quickly create web applications
- Host: GitHub
- URL: https://github.com/tristan-greffe/feathers-quasar-boilerplate
- Owner: tristan-greffe
- License: mit
- Created: 2023-04-04T14:14:05.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-27T18:53:25.000Z (about 2 years ago)
- Last Synced: 2024-05-28T04:18:36.570Z (about 2 years ago)
- Topics: boilerplate, feathers, feathersjs, js, quasar, quasar-framework, template
- Language: JavaScript
- Homepage:
- Size: 1.98 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Feathers Quasar Boilerplate
Report Bug
·
Request Feature
## About the Project
This boilerplate, inspired by [Kalisio](https://github.com/kalisio), is an application based on the **[FeathersJS](https://feathersjs.com/)** & **[QuasarJS](https://quasar.dev/)** frameworks for visualizing weather data in real time.
### Tech Stack
[](https://skillicons.dev)
### Features
1. Weather data visualization with [OpenWeathers](https://openweathermap.org/)
2. Interactive map: the interactive map is based on [Leaflet](https://leafletjs.com/), a powerful mapping framework.
3. Full authentication with [feathers-authentication-management](https://feathers-a-m.netlify.app/)
## Getting Started
### Step 1: set the required environment variables
| ENV | Description | Required |
|---|---|---|
| `GMAIL_USER` | Email used for gmail account | yes |
| `GMAIL_PASWORD` | Password for gmail account | yes |
| `GOOGLE_CLIENT_ID` | Customer ID for google authentication | no |
| `GOOGLE_CLIENT_SECRET` | Customer secret key for google authentication | no |
### Step 2: installing
#### From source code
```sh
git clone https://github.com/tristan-greffe/feathers-quasar-boilerplate.git
// Run the server/API
cd feathers-quasar-boilerplate/api
yarn install
yarn dev
// In another terminal run the client app
cd feathers-quasar-boilerplate
yarn install
yarn dev
```
> [!NOTE]
> Then point your browser to localhost:8080
#### Using minikube
##### Requirements
- [Minikube](https://minikube.sigs.k8s.io/docs/start/)
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- [Helm](https://helm.sh/docs/intro/install/)
##### Getting started
1. **Start Minikube** :
```sh
minikube start
```
2. **Navigate to `k8s` directory** :
```sh
cd k8s
```
3. **Run the installation script** :
```sh
./install.sh
```
##### Accessing applications
- **Feathers Quasar Boilerplate** :
- Open your browser and go to : `http://:30001`
- **Mongo Express** :
- Open your browser and go to : `http://:30000`
- Authentication :
- Username : `admin`
- Password : `admin`
> [!NOTE]
> To obtain Minikube's IP address, run the following command :
> ```sh
> minikube ip
> ```
### Testing
#### API
From the root folder run the server-side tests:
```sh
$yarn test:server
```
> [!IMPORTANT]
> To run the server-side tests, the server must not be running.
#### Client
From the root folder run the client-side tests:
```sh
$yarn test:client
```
> [!IMPORTANT]
> To run the client-side tests, you must first run the web app.
## Contributing
Contributions are always welcome!
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork it! 🤙
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -m "Add some feature"`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request 👍
## License
This project is licensed under the MIT License - see the [license file](./LICENSE) for details