Skip to content

Latest commit

 

History

History
129 lines (84 loc) · 4.38 KB

README.md

File metadata and controls

129 lines (84 loc) · 4.38 KB
Raw

CodeQL

Create Node App 💛

We're a Node.js project starter on steroids!


One-line command to create a Node.js app with all the dependencies auto-installed
AND
Easy config (alpha release) to generate Node.js source code for:

  • connecting to different databases (MySQL, PostgreSQL, SQLite3)
  • data model creation
  • CRUD API creation (REST, GraphQL)
  • unit tests and test coverage reporting
  • autogenerated test factories
  • linting and code formatting (eslint, prettier)
  • autogenerated API documentation (Swagger, ReDoc)

Quick start

  • Run the following command to create your new Node app:
npm install -g imagine && imagine create -f node -n myapp

If you don't have npm installed, you'll need to install this first.


  • You should see this:
$ npm install -g imagine && imagine create -f node -n myapp 

changed 214 packages, and audited 215 packages in 5s
....
found 0 vulnerabilities
32 files written
You have successfully created a new project!
Now you can run "cd myapp && imagine run" to install the dependencies and open a web server running at
http://127.0.0.1:8000/

  • Run cd myapp && imagine run to run your new Node app, and open http://127.0.0.1:8000/ to see that the install worked successfully.

  • Congrats! Your Node app is up and running!

  • Now that you've created your new app, check out the myapp.im in your app directory - using this you can:

    • easily change your app settings such as Node server, package manager, API format, database etc.
    • generate code for data models, CRUD APIs etc using our simple config spec.

  • Continue reading to learn more, or check out www.imagine.ai.


Learn more

Easy to create

  • Our one-line command allows your to get started with your Node.js app immediately, without worrying about installing dependencies - we take care of those, so you can focusing on writing business logic.

  • Our default settings when we create your Node app are as follows:

    • API format: REST
    • Database: sqlite3
    • Database name: myapp-db

  • These aren't the exact settings you want? No sweat, you can always change the settings as per your preferences - read on to see how to do this.


Easy to customize

  • If you want to change any of the above defaults for your app, its a piece of cake.

  • Go to the myapp.im file in your directory, your should see the basic default settings here:


settings

app:
    # your application name
    name: myapp
    # choose one: [django, node]
    framework: node

api:
    # choose one: [rest, graphql]
    format: rest

end settings

# database <database-name> <database type: [sqlite, mysql, posgresql]>
database myapp-db sqlite3
  • You can replace the default settings with your preferences (based on the options allowed), and then run imagine compile myapp.im in your terminal. Your app will be updated with the new settings.

Easy to add app functionality

  • Not only can you change your app settings easily, you can also generated production-ready code using the myapp.im file.

  • Use Imagine's simple syntax to generate code for data models and CRUD APIs to your Node app.

  • Run imagine compile myapp.im to see the generated code.

  • PS - all our generated code has:

    • unit tests and test coverage reporting
    • autogenerated test factories (using FactoryBoy)
    • linting and code formatting (you can select autopep8 or isort)
    • autogenerated API documentation (using Swagger and ReDoc)

  • PPS - in this repository, we have included an example to-do app that we created and generated using the todoapp.im file. You can check out the todoapp.im file that we used to create the Node.js app and express the specifications for the data models and APIs, as well as all the Node.js code files that are generated when you run imagine compile todoapp.im.

  • Have fun! 💛