Software Engineering
  • Contribution Workflow for Engineers
  • Collabo Community on Discord
  • PROJECT LOCAL DEVELOPMENT INSTRUCTIONS
    • Blocks Assistant (Javascript)
    • Blocks Assistant (Dart & Flutter)
    • Building Blocks
    • Collabocate (Javascript)
    • Collabocate (Flutter)
    • Collabo Community App
Powered by GitBook
On this page
  • General Information about project
  • Local development instructions

Was this helpful?

Edit on GitHub
  1. PROJECT LOCAL DEVELOPMENT INSTRUCTIONS

Blocks Assistant (Javascript)

SOFTWARE ENGINEERING CONTRIBUTING DOC FOR BLOCKS ASSISTANT

PreviousContribution Workflow for EngineersNextBlocks Assistant (Dart & Flutter)

Last updated 6 months ago

Was this helpful?


General Information about project


Local development instructions

Find the local development instructions for the different Blocks Assistant projects in the tabs below, depending on the one you want to develop locally.

Local development instructions:

  • Head over to the GitHub repository:

  • Fork and clone the repository as shown in the .


Instructions for installing dependencies and linking CLI:

Once you have the repository on your local computer, ensure you are in the root of the project's directory. Then install globally and uninstall globally following the steps below.

Install dependencies:

npm install

Link after installing dependencies, so that you can access/use the Create Collabo App commands in the terminal:

npm link

Unlink (this is for when you are done developing):

npm unlink

CLI commands and flags:

The way you operate/run the CLI is still largely the same as what is in the former at the moment. The only difference (for now) is the main CLI command i.e. Instead of node-mongo, use collabo-be. Similarly for the shorter version of the commands - instead of nmgo, use c-be.


Learning resources

  • - YouTube video.

  • - blog post.

Local development instructions:


Instructions for installing dependencies and starting the development server:

Once you have the repository on your local computer, follow the steps below.

  • Change directory into any of these folders in the repository, depending on the template you wish to work on: ts-esm-async-await folder, js-esm-async-await folder, js-cjs-async-await folder or js-cjs-then folder.


Handling .env files during development:

  • Retain the .env.example file so that it doesn't get deleted from our repo when you submit your code fix.

  • Create a copy of the .env.example file, rename this copy to .env , then change the PORT and add other environment variables to store your secrets as desired or as needed in your .env file.


Learning resources

No instructions for now. Please ask about this project on our discord channel if you are interested in contributing.


Head over to the GitHub repository:

Fork and clone the repository as shown in the .

Once in the chosen folder, follow steps 1 to 4 in the tabs under the section of the former Node mongo user docs, depending on the connection setup type you prefer to use. Some slight modifications to the steps exist: We have removed the automated dev server for now. For step 4, just use npm run dev:atlas or npm run dev:local script commands accordingly.

.

.

.

- 1st 33 minutes.

https://github.com/collabo-community/nodejs-backend-api-boilerplates
SWE contribution workflow
Running the generated backend API application
TomDoesTech: REST API with Node.js, Express, TypeScript, MongoDB & Zod
TomDoesTech: Module '"mongoose"' has no exported member 'DocumentDefinition'.ts (tutorial fixes)
Academind: Building a restful API with node.js
CodAffection: MEAN stack CRUD operations
https://github.com/collabo-community/blocks-assistant
SWE contribution workflow
Node Mongo user doc
Twilio | Dominik Kundel: How to build a CLI with node.js
Twilio | Dominik Kundel: How to build a CLI with node.js
Blocks AssistantCOLLABO COMMUNITY'S BLOCKS ASSISTANT PROJECT