A demo of the app is currently hosted at https://project-builder-e7439342976b.herokuapp.com/
Generally, Arduino/ESP32 projects have all of the creator's code in a single file (usually a .ino file or main.cpp). After logging into to this app, Click "New Build." Paste the URL of your Arduino/ESP32 main program file into the "Github main sketch file URL" section at the bottom of the form. Example URL: https://github.com/thisistamim/WIFI-Control-Car/blob/master/main.ino
When users visit your project's page on this app, the code section is automatically populated with your main project file's code from GitHub. This way you don't have to paste your code into this app every time you update your code on GitHub. This feature does that automatically!
Micro controller projects come with more than just code. There is also a parts list for any project.
It is for this reason that I created the "Fork Project" feature, which allows a user to fork another user's entire build, including both the parts list and code. Once a project fork is created, clicking "Project Forks" on a project's display page will show the forked versions of the project.
- React.js
- Express.js
- Objection.js
- PostgreSQL
- GitHub Apps
- Cypress.js
- More Material UI integration.
- Option to add a link to purchase parts from the parts list.
- Add a search feature for projects.
- Generative AI API integration for code suggestions.
- More usage of GitHub apps. Currently, it's just there to log in with GitHub.
-
Install necessary dependencies with
yarn:yarn install
-
In the root of the server folder, create a
.envfile to hold the environment variables listed below. These environment variables are used for:
SESSION_SECRET ...........This is for Passport. Allows Passport to keep track of the currently signed-in user in session.
GITHUB_API_KEY ...........You will need a GitHub API key to fetch code from a user's main project (.ino or main.cpp) file.
CLIENT_SECRET,
CLIENT_ID ................CLIENT_SECRET and CLIENT_ID are obtained when registering this app with GitHub Apps.
They are necessary for generating a user access token, which allows the app to perform actions with GitHub on the user's behalf.
See GitHub apps documentation for more information:
https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps
AWS_ACCESS_KEY_ID,
AWS_SECRET_ACCESS_KEY,
S3_BUCKET_PRODUCTION,
S3_BUCKET_DEVELOPMENT ....These are necessary for image uploading. For more information, visit
https://aws.amazon.com/s3/
BASE_URL .................This is necessary for the GitHub callback address (used with GitHub apps) where a full URL path is required.
If hosting this app on the web, be sure to replace http://localhost:3000 with the
base URL of your hosting site.
For example, https://project-builder-e7439342976b.herokuapp.com
.env:
SESSION_SECRET="your-session-secret"
GITHUB_API_KEY="your-github-api-key"
CLIENT_SECRET="your-client-secret"
CLIENT_ID="your-client-id"
AWS_ACCESS_KEY_ID="your-AWS-key-id"
AWS_SECRET_ACCESS_KEY="your-AWS-secret-access-key"
S3_BUCKET_PRODUCTION="your-AWS-S3-bucket"
S3_BUCKET_DEVELOPMENT="your-AWS-S3-bucket"
BASE_URL="http://localhost:3000"-
Create the base PostgreSQL database, project-builder_development
createdb project-builder_development
-
Run the included table migrations:
cd server yarn migrate:latest -
Run the seeder file to populate the app with example data:
cd server yarn db:seed -
Start up the application, from the root folder:
cd .. # if in the server folder yarn run dev
-
Navigate to http://localhost:3000. You should see the introduction page of the Project Builder application.