Giter Club home page Giter Club logo

autowriter's Introduction

This is a .NET application that I wrote after watching Jimmy Bogard's talk on vertical slice architecture as a way of understanding what it might look like in practice.

A screenshot of the Autowriter home screen

Running the app

  1. Ensure you have the .NET 6 SDK installed
  2. Clone the repository like git clone https://github.com/un1r8okq/Autowriter.git
  3. Open your favourite terminal in the cloned repository
  4. Ensure you are in the Autowriter.UI directory
  5. Run dotnet run to download dependencies, build the project, and run the kestrel web server. The app should open in your default browser automatically

Features

  • Upload source material (text)
  • Generate new text from your source material
  • Register with an email and password
  • Authenticate with email and password

Architecture

Autowriter.UI    __________   _______  
                | Register | | Login | 
                |__________| |_______|
                 ________________________   ___________                    __________
                | Upload Source Material | | View S.M. |                  | Generate |
                |________________________| |___________|                  |__________|
                       |_____________            |___________                   |_____________
Autowriter.Core        |             |           |           |                  |             |
                       V             V           V           V                  V             V
                 _____________   __________   __________   _____________   ____________   __________  
                | Create S.M. | | Get S.Ms | | Get S.M. | | Delete S.M. | | Count S.M. | | Generate |
                |_____________| |__________| |__________| |_____________| |____________| |__________|
                       |             |          |            |                |                |
Autowriter.Data        |             |__________|___________ | ______________ | _______________|
                       V             V                       V                V
                  ___________     ________               ___________      __________
                 | ICreateSM |   | IGetSM |             | IDeleteSM |    | ICountSM |
                 |___________|   |________|             |___________|    |__________|

Repository Structure

Autowriter.UI

This is an ASP.NET Core 6 Razor Pages application that acts as a basic UI over my application. It handles authentication of users and presentation of the functionality.

Autowriter.UI.Tests

This is a collection of tests for Autowriter.UI. It is made up of:

UnitTests

These use xUnit to validate the AutoMapper configuration. There isn't any domain logic in this project to test, only presentation code (which is very brittle).

IntegrationTests

These use an in memory test server to check that everything is talking. Things like

Autowriter.Core

This is the domain logic layer for the application.

Autowriter.Core.Tests

These use xUnit to test the core domain and storage logic of the application.

Autowriter.Data

This layer provides interfaces and implementation for data access.

Autowriter.Performance.Tests

This contains performance tests for Autowriter written in K6.

  1. Install K6
  2. From the repository root, start Autowriter like dotnet run --project Autowriter.UI/Autowriter.UI.csproj
  3. Run the tests like k6 run Autowriter.Performance.Tests/index.js

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.