Skip to content

caelinsutch/boiledegg

Repository files navigation

The Boiled Egg

Build Status Coverage Status BCH compliance Known Vulnerabilities Open Source Helpers HitCount

GitHub issues GitHub GitHub commit activity

Open Source Love TypeScript Join the chat at https://gitter.im/boiledeggwebsite/community

About this Project

Have you ever wanted a website with soleley egg recipes. Nothing but pages and pages of beautiful ways to prepare your eggs. Whether your preference is boiled, scrambled, fried, or pickled, this website is dedicated to bringing you different ways to prepare your favorite food.

Getting Started with Development

This project is built of of Angular 7, a web development framework built by google. We use Angular Material for front end components, and Google Firebase for authentication and database. Interested in contributing? Fork this repository or send me a message on gitter to start working.

For more information about getting started with development, reference the wiki.

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 docs

Run npm run-script builddocs to build documentation using typedocs.

Further help

To get more help on this project, send a text in the gitter chat