Build in Blocks [Assistant]
SOFTWARE ENGINEERING CONTRIBUTING DOC FOR BUILD IN BLOCKS ASSISTANT
General Information about project
Build in Blocks [Assistant]COLLABOCATE'S BUILD IN BLOCKS ASSISTANT PROJECTLocal development instructions
We've made recent changes to the repository location and local development instructions of this project. Therefore, this section may be outdated. For now and pending the time that this section will be updated, you can get guidance on where to find and how to run this project in our collabo community Discord channel.
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: https://github.com/collabo-community/blocks-assistant
Fork and clone the repository as shown in the SWE contribution workflow.
Instructions for installing dependencies and linking CLI:
Install dependencies:
npm installLink after installing dependencies, so that you can access/use the Create Collabo App commands in the terminal:
npm linkUnlink (this is for when you are done developing):
npm unlinkCLI commands and flags:
The way you operate/run the CLI is still largely the same as what is in the former Node Mongo user doc 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
Twilio | Dominik Kundel: How to build a CLI with node.js - YouTube video.
Local development instructions:
Head over to the GitHub repository: https://github.com/collabo-community/nodejs-backend-api-boilerplates
Fork and clone the repository as shown in the SWE contribution workflow.
Instructions for installing dependencies and starting the development server:
Change directory into any of these folders in the repository, depending on the template you wish to work on:
ts-esm-async-awaitfolder,js-esm-async-awaitfolder,js-cjs-async-awaitfolder orjs-cjs-thenfolder.Once in the chosen folder, follow steps 1 to 4 in the tabs under the Running the generated backend API application 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:atlasornpm run dev:localscript commands accordingly.
Handling .env files during development:
Retain the
.env.examplefile so that it doesn't get deleted from our repo when you submit your code fix.Create a copy of the
.env.examplefile, rename this copy to.env, then change thePORTand add other environment variables to store your secrets as desired or as needed in your.envfile.
Learning resources
CodAffection: MEAN stack CRUD operations - 1st 33 minutes.
No instructions for now. Please ask about this project on our discord channel if you are interested in contributing.
Last updated
Was this helpful?