Setting up our MVP in GitHub

does chatgpt really know how to code?

This is really the first of the posts that dives into the building process. I’ll include some basic questions here around Git, which will manage our repo. We’ll also talk about how to lay out the project, and commit our first ChatGPT generated code.

This is the repo for our email app:

https://github.com/cloudgamble/chatgpt-emailapp

And I will try to follow the advice as closely as I can. I’ll wait to set up CI/CD and monitoring as per suggested below until we have something to run, but other than that, we’ll give this a go.

Let me know if you would do something differently or if the guidance from ChatGPT is something you would try.

How do i set up github for my cloud email app?

“Setting up Github for your cloud email app involves a few basic steps:

1. Create a new repository: Log in to your Github account, navigate to the main dashboard, and click the "New" button to create a new repository. Give your repository a name and description, and choose whether you want it to be public or private.

2. Add files to the repository: Once you've created the repository, you can add files to it. You can either upload files directly to Github or clone the repository to your local machine and push changes back to the remote repository.

3. Configure settings: You can configure various settings for your repository, including the default branch, collaborators, and notifications.

4. Set up continuous integration/continuous deployment (CI/CD): You can use Github Actions to set up automated builds and deployments for your cloud email app. You can configure workflows that run on specific triggers, such as when a new commit is pushed to the repository or when a pull request is merged.

5. Monitor and manage changes: You can use Github's web interface to monitor changes to your repository, view commit history, and manage pull requests.

Overall, setting up Github for your cloud email app involves creating a new repository, adding files, configuring settings, setting up CI/CD, and monitoring and managing changes.”

What should the layout of my project look like on github

“The layout of your project on GitHub can vary depending on your preferences and the specific needs of your project. However, there are some common conventions that can make your project more organized and easier to navigate. Here are some general guidelines:

1. Create a clear and concise README file: This should be the first file that people see when they visit your repository. It should provide an overview of your project, including what it does, how to install it, and how to use it.

2. Create a separate folder for documentation: This can include things like user manuals, developer guides, and API documentation. Keeping all of your documentation in one place makes it easier for people to find what they need.

3. Create a separate folder for source code: This is where you should keep all of the code for your project. You can organize your code into subfolders based on functionality or module.

4. Create a separate folder for tests: This is where you should keep all of your test code. Having your tests in a separate folder makes it easier for people to run them and ensure that your code works as intended.

5. Create a separate folder for configuration files: This can include things like environment variables, deployment scripts, and database configurations. Keeping all of your configuration files in one place makes it easier to manage and update them.

6. Create a separate folder for assets: This can include things like images, videos, and audio files. Keeping all of your assets in one place makes it easier for people to find what they need.

Overall, the goal is to make your project organized and easy to navigate. By following these general guidelines, you can create a repository layout that works well for your specific needs.”

Can you help me with the folder names for each?

“Sure! Here is a possible folder structure for your project on GitHub:

javaCopy code

root/
├── backend/
│ ├── app/
│ ├── config/
│ ├── models/
│ ├── routes/
│ ├── tests/
│ ├── package.json
│ └── README.md
├── frontend/
│ ├── public/
│ ├── src/
│ ├── tests/
│ ├── package.json
│ └── README.md
├── docs/ │
├── diagrams/
│ ├── design/
│ ├── requirements/
│ ├── user-manual/
│ └── README.md
├── .gitignore
├── LICENSE
└── README.md

• backend/: contains all the backend-related files, such as the application code, configuration files, models, routes, and tests.

• frontend/: contains all the frontend-related files, such as the React components, CSS styles, and tests.

• docs/: contains all the project documentation, including diagrams, design documents, requirements, and user manuals.

• .gitignore: specifies files and directories that Git should ignore.

• LICENSE: specifies the open-source license that your project is released under.

• README.md: contains information about the project, such as how to build, run, and contribute to it.

Feel free to adjust this structure to fit the needs of your project.”

Can you create a readme in markdown for the cloud email marketing app with the above github configuration in mind as well as other best practices for a great README.md?

Sure, here's an example README.md for your cloud email marketing app:

and the results are on the GitHub:

https://github.com/cloudgamble/chatgpt-emailapp/blob/main/README.md