SonarCloud

Development codecov fullstack-template


Fullstack Template

A Full stack template with jwt authentication, and user management.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Testing
  5. Building
  6. Deploying
  7. Roadmap
  8. Contributing
  9. License
  10. Contact
  11. Acknowledgements

About The Project ⌨️

Built With 🛠️

Getting Started 🚀

To get a local copy up and running follow these simple steps.

Prerequisites 📋

  • Java 11
  • Node 14
  • Docker

Installation 🔧

  1. Clone the repo
    git clone https://github.com/kurama-dev/fullstack-template.git
  2. Install NPM packages
    npm install

Usage 🏹

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Testing ⚙️

Explain how to run the automated tests for this system

Test Backend

npm run test:backend

or

cd apps/api
.\mvn test

Test Frontend

npm run test:frontend

Test All

npm run test

E2E

npm run e2e

And coding style tests

npm run lint
npm run format:check

Building 🛠️

Build Backend

npm run build:build

Build Frontend

npm run build:frontend

Create Jar Package (Front+Back)

npm run package

or

cd apps/api
.\mvn clean package -P frontend

Deploying 📦

Deploying to heroku:

Branch development automatically deploys to heroku on success ci build.

Manual Deployment: You'll need to set HEROKU_API_KEY environment variable or user Heroku CLI to login first.

npm run deploy

or

cd apps/api
.\mvn clean deploy -P frontend,heroku

Roadmap

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

Contributing 🖇️

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  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

License 📄

Wiki 📖

More info on the project can be found in our Wiki

Contact ✒️

Email Github LinkedIn

Share 🔗

Email LinkedIn Facebook Twitter

Acknowledgements 🎁