Sky.Net/README.md

187 lines
4.4 KiB
Markdown
Raw Normal View History

2022-06-01 11:06:32 -07:00
<div id="top"></div>
2022-05-09 14:41:15 -07:00
2022-06-01 11:06:32 -07:00
<!-- PROJECT LOGO -->
<br />
<div align="center">
2023-01-29 12:15:10 -08:00
<a href="https://lab.skynetinc.tech/WorldDrknss/Sky.Net">
2022-06-01 11:06:32 -07:00
<img src="logo.png" alt="Logo" height="100">
</a>
<h3 align="center">Skynet</h3>
<p align="center">
Proof of concept e-commerce store using Angular, .Net Core and Stripe for payment processing
<br />
<br />
2023-01-29 12:15:10 -08:00
<a href="https://lab.skynetinc.tech/WorldDrknss/Sky.Net/issues">Report Bug</a>
2022-06-01 11:06:32 -07:00
·
2023-01-29 12:15:10 -08:00
<a href="https://lab.skynetinc.tech/WorldDrknss/Sky.Net/issues">Request Feature</a>
2022-06-01 11:06:32 -07:00
</p>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
2023-01-29 12:15:10 -08:00
# About The Project
2022-06-01 11:06:32 -07:00
2023-01-29 12:15:10 -08:00
[![Product Name Screen Shot][product-screenshot]](https://lab.skynetinc.tech/WorldDrknss/Sky.Net)
2022-06-01 11:11:57 -07:00
Proof of concept e-commerce store using Angular, .Net Core and Stripe for payment processing
* .Net Core
* Angular
* C# Generics
* Repository and Unit of Work Pattern
* Specification Pattern
* Caching
* Angular Lazy loading
* Angular Routing
* Angular Reactive Forms
* Angular Creating a MultiStep form wizard
* Accepting payments using Stripe
* Angular Re-usable form components
* Angular validation and async validation
2022-06-01 11:06:32 -07:00
<p align="right">(<a href="#top">back to top</a>)</p>
### Built With
* [.NET](https://dotnet.microsoft.com/en-us/)
* [NodeJS](https://nodejs.org/)
* [Angular](https://angular.io/)
* [Stripe](https://stripe.com)
2022-06-01 13:56:13 -07:00
* [Docker](https://www.docker.com/)
2022-06-01 11:06:32 -07:00
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- GETTING STARTED -->
2023-01-29 12:15:10 -08:00
# Getting Started
2022-06-01 11:06:32 -07:00
To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
2022-06-01 13:58:14 -07:00
* Docker
```sh
https://www.docker.com/
```
* .NET Core
```sh
https://dotnet.microsoft.com/
```
2022-06-01 11:06:32 -07:00
* npm
```sh
npm install npm@latest -g
```
* Angular
```sh
npm install -g @angular/cli
```
### Installation
1. Clone the repo
```sh
2023-01-29 12:15:10 -08:00
git clone https://lab.skynetinc.tech/WorldDrknss/Sky.Net.git
2022-06-01 11:06:32 -07:00
```
2022-06-01 13:56:13 -07:00
2. Setup Docker Containers: Configurations can be changed in `docker-compose.yml`
```sh
docker compose
```
3. Install NPM packages
2022-06-01 11:06:32 -07:00
```sh
cd client
npm install
ng serve
```
2022-06-01 13:56:13 -07:00
4. Restore .NET
2022-06-01 11:06:32 -07:00
```sh
cd API
dotnet restore -f
dotnet run
```
2022-06-01 13:56:13 -07:00
5. Add the following in API / `appsettings.development.json`
2022-06-01 11:06:32 -07:00
```js
"Token": {
"Key": "",
"Issuer": ""
},
"ApiUrl": ""
```
2022-06-01 13:56:13 -07:00
6. Add Stripe Information to API / `appsettings.json`
2022-06-01 11:06:32 -07:00
```js
"StripeSettings": {
"PublishableKey": "",
"SecretKey": ""
},
```
6. Update API / Controllers / `PaymentsController.cs` with your Strip Webhook Secret
```js
private const string WhSecret = ""
```
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- LICENSE -->
2023-01-29 12:15:10 -08:00
# License
2022-06-01 11:06:32 -07:00
Distributed under the MIT License. See `LICENSE` for more information.
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- CONTACT -->
2023-01-29 12:15:10 -08:00
# Contact:
2022-06-01 11:06:32 -07:00
2023-01-29 12:15:10 -08:00
Twitter - [@skynetinctech](https://twitter.com/skynetinctech)
2022-06-01 11:06:32 -07:00
Linkedin - [Charles Showalter](https://linkedin.com/in/charles-showalter)
2023-01-29 12:15:10 -08:00
Instagram - [@skynetinc.tech](https://twitter.com/skynetinc.tech)
2022-06-01 11:06:32 -07:00
2023-01-29 12:15:10 -08:00
Facebook - [@skynetinctech](https://facebook.com/skynetinctech)
2022-06-01 11:06:32 -07:00
2023-01-29 12:15:10 -08:00
Project Link: [https://lab.skynetinc.tech/WorldDrknss/Guide-to-AlmaLinux/](https://lab.skynetinc.tech/WorldDrknss/Guide-to-AlmaLinux/)
2022-06-01 11:06:32 -07:00
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
2023-01-29 12:15:10 -08:00
[twitter-shield]: https://img.shields.io/twitter/follow/skynetinctech?style=for-the-badge
[twitter-url]: https://twitter.com/skynetinctech
2022-06-01 11:06:32 -07:00
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
2023-01-29 12:15:10 -08:00
[linkedin-url]: https://linkedin.com/company/skynetinc
2022-06-01 11:06:32 -07:00
[product-screenshot]: Screenshot.png