Differences

This shows you the differences between two versions of the page.

--- 2.0 [2025/10/29 11:44]
20.171.207.2 old revision restored (2025/10/29 11:20)
+++ 2.0 [2025/10/30 07:52] (current)
216.73.216.23 old revision restored (2025/10/29 11:45)
@@ Line 13: / Line 13: @@
 ==== App Structure Overview ====
-Both the frontend and backend are programmed in Typescript which is executed by the [[https://www.npmjs.com/package/ts-node |ts-node]] package; Typescript is a type safe, and more structured superset of the javascript lanugage (ES6/ES12-ES2021). We use [[https://classic.yarnpkg.com/lang/en/docs/ |Yarn]] on the frontend and backend also, to install packages (like ts-node) and run a local development server.
+Both the frontend and backend are programmed in [[https://www.typescriptlang.org/docs/handbook/intro.html |Typescript]] which is executed by the [[https://www.npmjs.com/package/ts-node |ts-node]] package; Typescript is a type safe, and more structured superset of the [[https://www.freecodecamp.org/news/the-complete-javascript-handbook-f26b2c71719c/ |Javascript]] lanugage (ES6/ES12-ES2021). We use [[https://classic.yarnpkg.com/lang/en/docs/ |Yarn]] on the frontend and backend also, to install packages (like ts-node) and run a local development server.
-A GraphQL server is used in the backend, to provide structured and secure access to the data in our Database. We've not currently chosen a server to serve the backend code to the client, therefore, the project only works locally from development enviroments.
+An [[https://www.apollographql.com/ |Apollo GraphQL]] server is used in the backend, to provide structured and secure interface to interact with the database. [[https://github.com/typeorm/typeorm/blob/master/docs/active-record-data-mapper.md#what-is-the-data-mapper-pattern |TypeORM]] is the database adapter which connects to the database allowing us to manipulate the tables and data within it; graphql uses the TypeORM adapter in order to access the data. We've not currently chosen a server to serve the backend code to the client, therefore, the project only works locally from development enviroments.
-Our database is implemented in Postgres, which is a relational database that uses SQL.
+Our database is implemented in [[https://www.postgresql.org/ |Postgres]], which is a relational database that uses SQL. [[https://www.pgadmin.org/download/ |PGAdmin4]] is a decent tool for exploring the database.
-====Frontend====
+==== Packages ====
-====Backend====
+=== ts-node ===
-=== Packages ===
-== ts-node ==
 [[https://www.npmjs.com/package/ts-node |ts-node]] is a typescript execution engine that allows us to write this project as typescript instead of javascript. ts-node is essentially a `source-to-source compiler` / `transpiler`, as it  turns one language into another, i.e. typescript into javascript.
-== GraphQL (Apollo) ==
+=== GraphQL (Apollo) ===
 We use [[https://www.apollographql.com/ |Apollo GraphQL]] as our implementation of GraphQL.
 ([[https://odyssey.apollographql.com/ |Tutorial here]])
-== cross-env ==
+=== cross-env ===
 [[https://www.npmjs.com/package/cross-env |cross-env]] is used for setting the environment mode the project is run in, in a OS independant way. It is used in the package.json file.
+=== blipp ===
 [[https://www.npmjs.com/package/blipp |blipp]] is a simple hapi plugin to display the routes table to console at startup.
@@ Line 55: / Line 53: @@
 ===== Project setup and Build =====
-TBA
+==== Run the project locally ====
+Using the [[https://docs.npmjs.com/cli/v8/using-npm/scripts |scripts]] in the package.json file in the backend directory, use Yarn to run the 'dev' script, e.g.
+<code>yarn run dev</code>
+which is the same as running:
+<code>yarn run cross-env NODE_ENV=development ts-node-dev --files -- ./src/index.ts</code>
+  * 'Yarn' is our package manager, but also its acting as our server as this is a command for local development
+  * 'run' tells yarn to execute something
+  * 'cross-env' is a package used to set the programmign enviroment variables in a OS independant way
+  * 'NODE_ENV=development' is a cross-env option to set the enviroment to development
+  * 'ts-node-dev' is our typescript execution engine as we want our typescript files to be executed with a typescript engine
+  * '- -files' is a ts-node option, to tell ts-node to load files specified in the `tsconfig.json` file. We do this as the `blipp` package doesn't import correctly unless this happens, as ts-node can't see the blipp file in `backend/type/blipp.d.ts`
+  * '- -' is used to stop options being passed to ts-node (i.e. we passed ts-node '- -files', we don't want to pass anything else)
+  * './src/index.ts' is the first file we are running as it's the root
 === Potential build issues, and their fixes ===

DokuWiki

Site Tools

Differences

Page Tools