Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. In order to run the database for the first time, you will need to execute the following command in the CLI (make sure you’ve navigated back to the base folder of the repo!). Run yarn prisma:reset. This should apply

    1. This combines three commands for you: yarn prisma:migrate which applies all the existing database migrations to the database

    (create the required tables in the database
    1. ,

    see
    1. yarn prisma:

    migrate) and populate the database with seed data (see
    1. generate which builds the type files for typescript so you can code with it, and yarn prisma:seed

    ).
    1. which populates the database with test data

  2. Refer to prisma migration tools for more information about these commands.

...

  1. To test that things are working, run yarn install and then yarn start in the CLI (in the root directory) and go to an example API route. Example: localhost:3001/users.

    1. Then go to localhost:3000 to see the dashboard (if it does not launch automatically)! Feel free to take a look around!

  2. IDE: VSCode

    1. We use VSCode at NER. You can use something else, but we won’t be able to help you if you have problems. VSCode is pretty industry standard though, so it’s very good to know.

    2. Click File > Open Folder then navigate to the repo and open it

    3. There should be a popup in the bottom right asking you if you want to install the recommended extensions. Click install.

      1. If for some reason this doesn’t show up, the following are the mandatory VSCode extensions. You can install them manually by clicking the extensions tab on the left (it looks like building blocks) and searching for them:

        1. Jest (orta.vscode-jest)

        2. Prisma (prisma.prisma)

        3. ESLint (dbaeumer.vscode-eslint)

        4. Prettier (esbenp.prettier-vscode)

      2. And the optional ones (for a better experience):

        1. Babel (mgmcdermott.vscode-language-babel)

        2. Material Icon Theme (pkief.material-icon-theme)

  3. Congrats!

    1. You now (theoretically) have a functioning environment! Congratulations! If not, please look at the FAQ page, and if that doesn’t help, look for further help in the #software_env-setup slack channel (more info down below). Once again, here is the link to the repo (and here is the link to the outdated repo which still holds a lot of useful information).

...

Learn about the technologies we use and join Slack ! The technologies are mentioned below and on the GitHub repository. (see below)! If you are not familiar with the technologies, don’t worry! We have a some learning curriculumresources to help with the basics! Also, if you are not familiar with Git, please familiarize yourself with common git commands, CLI commands, and what Git is (if you get the gist you do not need to read through all of it). You may also follow tutorials found in the NER curriculum for this information as well as attend Learning Session #1. When you are ready to start development on the codebase, please read through the contributor guide on the GitHub repo.

...

Our Product Team exists as a wonderful resource for all developers on the Software Solutions team. Product Analysts, Product Managers, and our head Head hold key business facing information for all parts of our application, and are a great resource to go to if you have non-technical questions. Make sure to reach out to relevant analysts, PMs, or even Leroy first before reaching out to others for these questions in case they can answer your questions.

...