Coqui.Monster is primarily a React app with custom components utilizing the Material UI Library and built on the NextJS Framework and managed by Payload CMS.
All code within this project are intended for use by Coqui for her website Coqui.Monster
Coqui.Monster is currently hosted on Netlify and is built and deployed through GitHub Actions. The project will hopefully be moved to Cloudflare in the future for better performance and to take advantage of the more generous usage limits. This is dependent on OpenNext's upcomding functionality with Cloudflare to allow both Next and Payload to function within Cloudflare's ecosystem.
You will need to have Node.js and npm installed on your machine. You can install these from the official website at https://nodejs.org.
Once you have Node.js installed, you can clone the 3AM repository to your local machine using Git: git clone https://github.com/Sevrene/Coqui.Monster.git
or through the GitHub repository for a direct download.
Next, navigate to the project directory within cmd prompt and, if required, install the required dependencies using npm:
cd {pathToParentFolder}/Coqui.Monster
npm installFinally, start the development server to launch the app in your web browser:
npm run dev
Open http://localhost:3000 with your browser to see the result.
Instead of running locally you can run the project on the cloud with Codespaces.
Navigate to Codespaces from the GitHub repository. You will be presented with an in browser IDE and this README.
Open up a terminal within this IDE if one is not already open and start the development server to launch the app in your web browser with npm run dev and stop this development server with ctrl + C
You will be prompted with a popup to open the app within your browser. If you are not prompted, navigate to http://localhost:3000 with your browser manually to see the result.
Coqui.Monster is licensed under the MIT License except where otherwise noted. See the LICENSE file for more information and/or the respective license files in the directories of the project.
All pull requests and issues are welcome on the GitHub repository.