Code Monkey home page Code Monkey logo

miranasolution's Introduction

Mirana Online Reader

GitHub last commit (by committer) GitHub last commit (by committer) GitHub code size in bytes

A mini Chinese novels reader which was built based on traditional Three-layer architecture with ASP.NET Core and Dependency Injection for loose coupling.

Technologies and libraries used in this project:

  1. For front-end side:
    • Using React for smooth UI and also some related libraries. i.e: Framer-motion for animation and Tailwindcss for all styling stuffs in the project.
    • Also using axios to facilitate the API callings.
  2. For back-end side:
    • Using ASP.NET Core for exposing API to clients.
    • Based on Three-layer architecture with three main layers: Data (DAL), Services (BLL) and WebApp (UI).
    • Using SQL Server for persistence.
  3. Cloud Services:
    • AWS EC2: for deployment.
    • AWS RDS: A storage solution in Production environment.
    • AWS SES: Delivering recovery email to the users.

How to install

  1. Clone the project.

  2. Navigate to the src/miranaSolution.API folder and configure change the connection string in appsetings.json:

     "ConnectionStrings": {
         "Database": "Server=localhost;Database=MiranaSolution;Trusted_Connection=True;"
     }

    Also change the other settings if needed.

  3. To create the migration and update the database, turn back to the root folder and run the commands below:

    dotnet ef migrations add Initialize -s ./src/miranaSolution.API/ -p ./src/miranaSolution.Data/
    dotnet ef database update -s ./src/miranaSolution.API/ -p ./src/miranaSolution.Data/
  4. Finally, run the following command to start the API:

    dotnet publish -c Release
    dotnet ./bin/Release/net6.0/miranaSolution.API.dll

For front-end:

  1. Navigate to the src/frontend/miranaSolution.WebApp folder, then create the .env file with those contents:
    VITE_BASE_ADDRESS=<API-Address>
    
    Replace <API-Address> with the API Address when running API above
  2. Build the WebApp project:
     npm run build

How to test

Just simply go to the root/tests/miranaSolution.Services.Tests and run the command:

dotnet test

Some screenshots

Header

Home

Login

miranasolution's People

Contributors

weebneedweed avatar

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.