Code Monkey home page Code Monkey logo

create-fullstack-app's Introduction

create-fullstack-app

Create Fullstack TypeScript application with ease.

⚠️ This project is not anymore maintained, you can still use the code as you wish and fork it to maintain it yourself.

Licence MIT Contributor Covenant Dependabot badge

Conventional Commits semantic-release npm version

Google Chrome Lighthouse

πŸ“œ About

create-fullstack-app is a CLI tool to easily generate boilerplate code for your projects with TypeScript. You don't need to learn and configure many tools and create the basics folders/files so you can focus on development. There are many templates available so you can generate any projects (front-end, back-end or both by default) with any frameworks.

πŸš€ Features

πŸ“¦ Templates availables

Website (front-end)

API (back-end)

βš™οΈ Usage

npx create-fullstack-app <directory-name>

It will ask you some questions (template(s), name, description, etc.), when answered, it will copy and install all the dependencies needed for your project.

Options

-V, --version       Output the version number.
-h, --help          Display help for command.
--only-website      Generate only a website project.
--only-api          Generate only an API project.
--no-install        It avoids the installation of npm packages inside `node_modules`.
--github            It creates a `.github` folder that contains issues templates, pull request templates and configurations for GitHub Actions.
--template-api      Choose the API template.
--template-website  Choose the Website template.

πŸ’‘ Contributing

Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.

The steps to contribute can be found in the CONTRIBUTING.md file.

πŸ“„ License

MIT

create-fullstack-app's People

Contributors

dependabot[bot] avatar theoludwig avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

create-fullstack-app's Issues

[Feature] Add new option: --github

Description

Today, every modern fullstack application needs continuous integration.

Describe the solution you'd like

The idea is to add 1 new option (optionnal) to the cli :

--github

It creates a .github folder at the root folder and creates the workflow for GitHub Actions, ISSUE_TEMPLATE, CODE_OF_CONDUCT.md, CHANGELOG.md files + scripts folder to make releases and installation easier.
Also will ensure that everyone follows the same commit message guidelines : @commitlint/config-conventional and Semantic Versioning for releases.
On each pull request/push to master, it will run : npm run lint, npm run test and npm run build commands.

[Feature] Ability to use CLI options instead of inquirer

Description

When creating a new project, it asks what template we want to choose thanks to inquirer but this makes it impossible to use programmatically.

Instead, if the user specifies, --template-api or --template-website, we don't need to use inquirer to ask the user.

Choose the stack template

For the moment, you can only generate a create-fullstack-app with Next.js (React.js framework for server-side rendering) and Express.js with Sequelize.

The idea is to have multiple choices of templates for differents stacks.
For the moment the stacks I want to be added are :

Frontend : Nuxt.js (Vue.js framework for server-side rendering).
Backend : Nest.js (A progressive Node.js framework for building efficient, reliable and scalable server-side applications.)

Feel free to tell me what stacks template you want to be added.

Note : This might take some time, because it's not my priority right now but feel free to discuss there and to open pull-request.

[Bug] Replace {{ projectName }} in the newly created project

The current behavior

Currently when we create a new project, it doesn't replace {{ projectName }}, {{ projectDescription }} and so on in the newly created project.

The expected behavior

We should replace the variables recovered thanks to inquirer in the new project.
To do that, we could use replace-in-file (the same library, we used in [email protected].

Mongodb & Fastify

I loved this package. I'll be happy If You'd add MongoDB and Fastify support.

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

[Bug] 'Unexpected token ?' when trying to use 'npx create-fullstack-app <dir_name>'

So, I just tried to generate project using npx create-fullstack-app test
I tried with already created test dir, and without it. Also tried with sudo but got nothing.

ezop@ezop-linux:~/work$ ls -al
total 16
drwxrwxr-x  4 ezop ezop 4096 kwi 15 22:10 .
drwxr-xr-x 23 ezop ezop 4096 kwi 15 22:10 ..
drwxrwxr-x  7 ezop ezop 4096 kwi 15 21:53 clients-reminder
drwxrwxr-x  2 ezop ezop 4096 kwi 15 22:10 test
ezop@ezop-linux:~/work$ npx create-fullstack-app test
npx: installed 152 in 5.214s
Unexpected token ?

Im on Ubuntu 20.04.2 LTS

ezop@ezop-linux:~/work$ npm --version
6.14.4

Steps To Reproduce

  1. Just use npx create-fullstack-app test

The current behavior

ezop@ezop-linux:~/work$ npx create-fullstack-app test
npx: installed 152 in 5.214s
Unexpected token ?

The expected behavior

Possibly: "It will ask you some questions (template(s), name, description, etc.), when answered, it will copy and install all the dependencies needed for your project."

Avoid using `latest` in package.json of templates

Description

Currently, each template have a package.json with the dependencies values of latest so when we initialize a new project we always have the latest up to date dependencies.

Describe the solution you'd like

Instead we should programmatically, run npm install deps1 deps2 etc so we have still the latest version when we initialize a new project but in the package.json there are the real version, we're using so everything should work fine.

Follow best practices by using standardJS

Right now, the frontend and the API REST is using a custom prettier configuration.
It would be great that it consider using standardJS, the JavaScript Standard Style.
The real problem is that standardJS have an outstanding issue with standard and Typescript where standard would incorrectly emit unused-variable errors, and the other problem is it's not really compatible with styled-jsx.

As always, feel free to discuss about that potential code style change and to open pull-requests.

[Improvement] Add more automated tests

Type of Improvement

Tests

Proposal

The tests in create-fullstack-app are weak and many things are not automated tested.
We should add more robust test with jest, also we could maybe add end to end (e2e) tests.

Update README.md about "Advice" section

Documentation :

  • Is Missing
  • Is Confusing
  • Has Typo errors
  • Not Sure?

Proposal

Since Web App Manifest Generator is not working anymore. You can't generate your own icons of various sizes for your PWA generated with create-fullstack-app.

The solution is to find an alternative and to update the Advice section of the README.md file.

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.