Giter VIP home page Giter VIP logo

ligma-stack's Introduction

LIGMA Stack

Welcome to the LIGMA Stack! This project serves as a starting point for full stack applications using Next.js, complete with backend API integration, authentication, and more.

Table of Contents

Overview

This boilerplate is configured to provide a solid foundation for building scalable and maintainable web applications using Next.js. It includes both frontend and backend setup, so you can focus on building your features right away.

Features

  • Server-Side Rendering: Leverage the power of Next.js for server-side rendering.
  • API Routes: Built-in API routes for backend operations.
  • Authentication: Basic authentication setup with JWT.
  • Database Integration: Ready for database integration with ORM (e.g., Prisma).
  • State Management: Context API setup for state management.
  • Styling: Configured with CSS-in-JS library (e.g., styled-components).
  • Linting and Formatting: ESLint and Prettier configured for code quality.
  • Unit and Integration Testing: Jest and React Testing Library setup for testing.
  • Client side validation: using Zod

Roadmap

  • Add MDX support for basic pages
  • Payments using Stripe
  • Responsive styles
  • Add OG image for blog using @vercel/og
  • Build marketing pages

Tech Stack

Getting Started

Prerequisites

Make sure you have the following installed:

Installation

  1. Clone the repository:

    git clone https://github.com/jbwashington/ligma-stack.git
    cd ligma-stack
  2. Setup AWS account:

  • configure secret key in AWS Console
  • install awscli
  • configure awscli
  1. Install dependencies:

    pnpm install
    # or
    npm install
  2. Environment variables:

    Rename .env.example to .env.local file and add your environment variables. For example:

    DATABASE_URL=postgresql://user:password@localhost:5432/mydb
    JWT_SECRET=your_jwt_secret

Folder Structure

.
├── app
│   ├── layout.tsx
│   └── page.tsx
├── components
│   ├── ui
│   │   ├── alert-dialog.tsx
│   │   ├── button.tsx
│   │   ├── dropdown-menu.tsx
│   │   └── ...
│   ├── main-nav.tsx
│   ├── page-header.tsx
│   └── ...
├── lib
│   └── utils.ts
├── styles
│   └── globals.css
├── next.config.js
├── package.json
├── postcss.config.js
├── tailwind.config.js
└── tsconfig.json

Running Locally

To start the development server, run:

yarn dev or npm run dev

Your app should now be running on http://localhost:3000.

Deployment

To deploy your application, we are using SST, which deploys seamlessly to AWS.

Contributing

Thank you for considering contributing to this project! Feel free to open issues or submit pull requests.

Steps to contribute

Fork the repository. Create a new branch: git checkout -b feature/your-feature-name Make your changes. Commit your changes: git commit -m 'Add some feature' Push to the branch: git push origin feature/your-feature-name Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Feel free to customize this template further based on your specific needs and preferences!

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.