This is an explanation of the more important packages in the project Seperated by Server/Site and CLI packages. Additionally you can read more about the packages on the blog post here.
These are the notable packages that are used in the project. A full list can be found in the corresponding
This is the UI component library used for the overall style of the website. The website for the package is here. It follows the material UI principles laid out by Google.
This package allows for the use of
.env files which contain environment
variables such as database passwords, which ports the host server is on,
or if the server is in development or production mode. However the main
.env files are loaded by Nextjs where
dotenv is used for unit testing.
This is one of the most critical packages. It is a web framework for node.js that simplifies code alot. It's great, so much so I will link it here.
Related to express package here. Handles session management and tokens.
This package help abstract out request body and param validation to ensure that the correct data is sent.
Adds object modeling for MongoDB documents. MongoDB is a noSql database so there isn't any structure to entries (anything can be added to anything). Mongoose adds some structure to those entries such as making sure certain fields exists or only have certain data types. Found here
A reactJs framework that allows for server side rendered pages. Found here
Authentication package. Found here.
Some of the packages carry over from the server/site such as the database packages of MongoDB and Mongoose.
The main package that sets up the command line interface.
Allows to store data passed to the CLI, such as the MongoDB URI.
Allows for user input into the CLI
Unit Testing, Linting, Formatting
One major change for v3 Dashboard was the addition of unit testing, linting and formatting of code.
Unit test package.
Allows creation of fake Request and Response Objects for unit testing.
Performs linting to help keep code up to good practices and checks syntax.
Runs linting and formatting commands on commits and push events.