Skip to content

Latest commit

 

History

History
198 lines (154 loc) · 5.77 KB

README.md

File metadata and controls

198 lines (154 loc) · 5.77 KB
Raw

Contributors Forks Stargazers Issues MIT License


Sway

A simple, enterprise-grade, database-first e-commerce platform.
View Demo »

Explore the docs · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments

About

An experimental e-Commerce platform written in C# and TSQL. This project is for education purpose only as I intentionally shift as much logics to the database as possible. For the entities and database design, please refer to the drawio document.

(back to top)

Built With

The technologies and tools used within this project.

  • .NET Core
  • .NET MVC
  • Pnpm
  • TailwindCSS/DaisyUI
  • JavaScript
  • jQuery
  • React
  • TSQL/SQL Server
  • Powershell
  • xUnit

(back to top)

Getting Started

Prerequisites

The list of tools that is used when development.

Installation

To run this template project in your local for personal use or contribution, simply perform the following.

  1. Clone the repo 
    git clone https://github.com/data-miner00/Sway.git
  2. Install Node dependencies 
    pnpm i
  3. Restore Nuget 
    dotnet restore
  4. Build projects 
    dotnet build
  5. Restore database (steps coming soon..)
  6. Run Mvc 
    dotnet run --project src/Sway.Web.Mvc/Sway.Web.Mvc.csproj

(back to top)

Roadmap

  • Add OAuth/OIDC/Okta authentication
  • Add QRCode
  • Add export history
  • Add notification
  • Use RabbitMQ
  • Use Grafana for telemetry tracking
  • Create GitHub CI
  • Configure code coverage with report generator
  • Create GraphQL API
  • Create API
  • Create Blazor portal
  • Create Mobile App

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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 the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

List of resources that are helpful and would like to give credit to.

(back to top)