Scala Fullstack Scaffold

Build easily your REST API and ScalaJS Frontend with this scaffolding project !

Documentation · Report Bug · Request Feature

📔 Table of Contents

• 📔 Table of Contents
  • 🌟 About the Project
    • 🎯 Features
  • 🧰 Getting Started
    • ‼️ Prerequisites
    • 🏃 Run Locally
    • 🚀 Build
  • 👋 Contributing
  • ⚠️ License
  • 🤝 Authors

🌟 About the Project

Scala Fullstack Scaffold is a projects aims to start quickly a Frontend and a Backend application. It uses ZIO HTTP for the backend and and ScalaJS for the frontend application.

🎯 Features

• Create a Template with some customisation:
  • Choose a name for you're project
  • Choose between MongoDB or Postgres backend's database
• Expose a RESTful API
• Display a Frontend application

🧰 Getting Started

‼️ Prerequisites

• Scala >= 2 for the Backend
• Scala >= 3 for the Frontend
• Node.JS 18 for the Frontend application and the documentation

# Install Scala 3.3.0
curl https://github.com/lampepfl/dotty/releases/download/3.3.0/scala3-3.3.0.tar.gz -sSf | sh

# Install Node 18.16.0
curl https://nodejs.org/dist/v18.16.0/node-v18.16.0-linux-x64.tar.xz -sSf | sh

🏃 Run Locally

Clone the project

  git clone https://github.com/do4-2022/scala-fullstack-scaffold.g8.git

Go to the project directory

  cd scala-fullstack-scaffold

Run the backend :

  cd backend
  sbt run

Run the frontend :

  cd frontend
  sbt run

Run the documentation :

  cd frontend
  npm run dev
  sbt:livechart> ~fastLinkJS

🚀 Build

Build This Fullstack with NPM

  cd documentation
  npm run build

👋 Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

⚠️ License

Distributed under the mit License. See LICENSE.md for more information.

🤝 Authors

This project was developed by some DO students at Polytech Montpellier in June 2023:

• Nils Ponsard(Frontend)
• Esteban Barron(Backend)
• Maxime Pizzolito(Backend)
• Arsène Fougerouse(Documentation)

Project Link: https://github.com/do4-2022/scala-fullstack-scaffold.g8