Next.js + Apollo initial boilerplate

An initial boilerplate built with Next.js + Apollo (Server & Client) + GraphQL + Sequelize + Material UI

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This repository is an initial point that helps you can start a simple web application with Next.js and Apollo.

The application includes both GraphQL API and Frontend layers in a single source package (although these layers should be separated in the big project). For database layer, the project uses SQLite, which can be replaced with the other SQL databases such as MySQL, Postgres, MariaDB and Microsoft SQL Server.

Built With

• Next.js
• Apollo Server
• Apollo Client
• Express
• React
• GraphQL
• Sequelize
• SQLite
• Material UI

Getting Started

Prerequisites

You need to install these packages below to run the application locally.

• Node.js
• Yarn

Installation

1. Clone the repo

   git clone https://github.com/antrant/next-js-apollo-initial-boilerplate.git

   then

   cd /to/your/repo

2. Install Node packages

   yarn install

3. Clone .env file from .env.example, change the file content to yours.
4. Run database migration:
   • Change config/config.json content to yours.
   • Run migration

   npx sequelize-cli db:migrate

5. Start application in development mode

   yarn dev

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

Distributed under the MIT License. See LICENSE for more information.

Contact

LinkedIn: An Tran

Project Link: Next.js Apollo Initial Boilerplate