diff --git a/.vscode/settings.json b/.vscode/settings.json index 20c831d..4c7b2c3 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -42,7 +42,8 @@ "CHANGELOG.md": true, "coderoad.yaml": true, "tutorial.json": true, - "TUTORIAL.md": true + "TUTORIAL.md": true, + "README.md": true }, "html.autoClosingTags": false, "npm.fetchOnlinePackageInfo": false, @@ -94,4 +95,4 @@ "workbench.tips.enabled": false, "workbench.tree.renderIndentGuides": "none", "zenMode.centerLayout": false -} \ No newline at end of file +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..571a235 --- /dev/null +++ b/README.md @@ -0,0 +1,94 @@ +# Learn World Cup Database + +This is the starter project for the [Build a World Cup Database](https://www.freecodecamp.org/learn/relational-database/build-a-world-cup-database-project/build-a-world-cup-database) project +on FreeCodeCamp. + +In order to get credit for completing the project, it must be completed on Gitpod. However, +it can be completed locally. + +## Working on the project using Gitpod + +### Prerequisites + +- [A GitHub account](https://github.com) + +#### Obtaining the prerequisites + +1) Open up a web browser and [navigate to GitHub's join page](https://github.com/join) +2) Enter your email address in the provided line and hit the "continue" button. +3) Enter your password on the new input line. The password must be at least 8 characters long with a number +and lowercase letter. +4) Hit the "continue" button and type in a username. Then hit the continue button. +5) Read the text to the right of the checkbox. If it sounds appealing, hit the checkbox and hit continue. +6) Wait a few minutes while GitHub verifies your account. +7) A new GitHub account has now been created. + +### Getting Started + +On the [FreeCodeCamp project page](https://www.freecodecamp.org/learn/relational-database/build-a-world-cup-database-project/build-a-world-cup-database), click on the "Start the project" +button. + +It will open up the Gitpod website and require you to sign in. Hit the `Continue with GitHub` +button and proceed. The website will open up a new Gitpod workspace with the project loaded up. + +Hit the `F1` key on the keyboard to open up the command dropdown. Either type in the search box +or find "CodeRoad:Start" in the dropdown. Hit enter. + +A new tab will appear on the page with the instructions. Follow the directions and hit run when you +complete the tasks. + +## Working on the project locally + +### Prerequisites + +- The [Docker Engine](https://docs.docker.com/engine/install) +- [VS Code](https://code.visualstudio.com/download) +- The [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) for +VS Code. +- [Git](https://git-scm.com/downloads) + +#### Obtaining the prerequisites + +The very step is to open up the download page for [Docker](https://docs.docker.com/engine/install/). Click on +the option appropriate option for the computer; whether it is running Linux, macOS, or Windows. + +If virtualization is not enabled on the operating system, please check the links on the Docker page. + +Once everything is ready. Click on the applicable "Download" button and run it. Let Docker install and +setup what it needs to run. + +Next [Visual Studio Code](https://code.visualstudio.com/download) needs to be installed. This will +be used to write code and display the instructions for the project. Hit the download button for the correct operating +system, and install it. + +Once Visual Studio Code is installed, an extension is needed to use a Docker container as a development +environment. Hit the "install" button on the [Visual Studio Code Marketplace page](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). + +Once the extension is enabled, it is time to proceed to the final step: installing git. Git will provide +command-line access to remote source control repositories like GitHub. Navigate to the Git [download page](https://git-scm.com/downloads) +and hit the link for the computer's operating system. Install instructions will vary depending on what operating +system is used. + +## Running the project + + + +1) Clone the RDB Alpha repo to your computer with `git clone https://github.com/freeCodeCamp/rdb-alpha` + +2) Open a terminal, navigate to the `rdb-alpha` directory, and open VS Code with `code.` + +3) In VS Code, open the command palette with `Ctrl / Cmd + Shift + P`. Then, enter and run `Dev Containers: Rebuild and Reopen in Container` + +4) A new VS Code window will open and begin building the Docker image. It will take several minutes to build the first time + +5) Once the image is finished building, open the command palette again with `Ctrl / Cmd + Shift + P`, enter and run `CodeRoad: Start`. The command won't be available until the extension has finished installing in your container + +6) In the CodeRoad window, click `Start New Tutorial` + +7) Click the `URL` tab and enter the URL of the `tutorial.json` file for the project you want to start (ex: https://raw.githubusercontent.com/freeCodeCamp/learn-bash-by-building-a-boilerplate/main/tutorial.json) Full list of available tutorials below. + +8) Click the "Start" button to start the lessons + + + +