Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/agencyenterprise/aeboilerplate

AEboilerplate is an opinionated boilerplate that creates a full-stack React/Node Typescript project, with independent client and API structures in the same repository, ready to run and deploy.
https://github.com/agencyenterprise/aeboilerplate

axios boilerplate circle-ci create-react-app docker docker-compose editorconfig express jest knex node npm oauth2 passportjs prettier react redux rest tslint typescript

Last synced: 3 months ago
JSON representation

AEboilerplate is an opinionated boilerplate that creates a full-stack React/Node Typescript project, with independent client and API structures in the same repository, ready to run and deploy.

Awesome Lists containing this project

README 

        
# AEboilerplate



[![aeboilerplate license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/agencyenterprise/aeboilerplate/blob/master/LICENCE.md)

[![build](https://circleci.com/gh/agencyenterprise/aeboilerplate.svg?style=shield&circle-token=3d749403becdba1c3b622fb512abad50192930b6)](https://circleci.com/gh/agencyenterprise/aeboilerplate)

[![npm version](https://badge.fury.io/js/aeboilerplate.svg)](https://badge.fury.io/js/aeboilerplate)



A full-stack React/Node/Typescript web project starter that focuses primarily on ease-of-use and simplicity.



AEboilerplate is an _opinionated_ boilerplate that includes independent client and API applications packaged into one repository. It is ready to be run and deployed out-of-the-box and comes preconfigured with state management, continuous integration, testing, code-formatting, and much more.



- **Easy to setup**: Initial setup is as simple as running a single command.



- **Opinionated**: We spent a lot of time thinking about which technologies would allow us to build applications out more quickly with guardrails in place to keep our codebase tidy and maintainable.



- **Clean**: We try to follow the KISS (Keep it simple, stupid) pattern. So we built this boilerplate adding what every robust application needs and more.



- **Customizable**: Configurations are localized for easier management.



## Motivation



At [AE Studio](https://ae.studio/), we are constantly working on new projects and find ourselves spending time setting up applications that could be better used to build out features. To improve our process, we decided to take our favorite technologies and bundle them into a boilerplate to help kickstart our projects faster.



## Getting Started



### You will need to have these installed first



- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

- [Node 8+](https://nodejs.org/en/)

- [Docker 18+](https://docs.docker.com/install/)

- [Docker Compose 1.21+](https://docs.docker.com/compose/install/)



### Generate a new project with a simple command



```bash

npx aeboilerplate PROJECT_NAME

```



## Documentation



Please check out our full [boilerplate documentation](https://github.com/agencyenterprise/aeboilerplate/blob/master/docs/documentation.md).



## Contributing



We, at [AE Studio](https://ae.studio/), believe in the value of having a [growth mindset](http://www.aaronsw.com/weblog/dweck). In sharing our work, we hope to improve upon our own practices with the help of the wider community as there's always room for improvement. Likewise, we hope that our work brings value to you.



As we continue to maintain this project, we would love to hear from you. If you have any ideas, please [open an issue](https://github.com/agencyenterprise/aeboilerplate/issues/new). Or, if you would like to contribute, pull requests are warmly welcomed.



## License



This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/agencyenterprise/aeboilerplate/blob/master/LICENCE.md) file for details