alexowen/example-react-project

example-react-project's Issues

Split the API routes into separate files

The routes are grouped by function, but would be better if they had a separate file per route and method.

More comprehensive front end testing, including stubbing the back end

The front end testing is very basic

Re-do CORS implementation

It is very insecure at the moment: it does not check whether the referrer is allowed.

Add testing via HTTP

Using chai-http - https://www.chaijs.com/plugins/chai-http/

Improve MongoDB connections

At the moment a new connection is opened per request, this could be improved with pooling/sharing.

Also, lots of code is duplicated.

Add a logging helper

Use Typescript for the API

Type checking would make the API more reliable and easier to test

Allow users to create an external config file

Containing external ports, database port, etc.

Break form validation out into a separate file

The form validation is all in the route module at the moment. It would be useful to have it as a separate module and to remove some duplication.

Proper JSDoc documentation

The documentation on the code is below what I would want to push to production, but the majority of it is hopefully straightforward enough it documents itself*.

*I know this isn't true.

MongoDB connections do not close properly

This would be a pretty serious memory leak/bug in production.

More comprehensive back end testing, including stubbing the database

Use a more structured API

This could be done well using Lambda, or at least a framework to generate both the skeleton and an OpenAPI/Swagger definition.

Pass errors through to the front end/user

At the moment any error will fail silently and the user is not notified. The UX would be significantly improved if the user knew what the error was or which field has failed validation.

Create a GitHub issue template

These issues are a mess, they should include steps to reproduce or a brief at least.

Alter the email regex to require a '.' in the domain

The current regex is technically correct, but we don't want to allow email addresses without a .

Use proper code guidelines

Possibly AirBnB's style guide - https://github.com/airbnb/javascript

Improve the UX for the submit button to show what is incorrect/missing

The error handling on the front end is very basic.

Move the front end and API to separate repositories

If this were a commercial project, there would be at least two repositories.

Check the shape and contents of items returned from the database

At the moment anything that comes from the database is returned directly to the client. There should be some checking here.