zenware / alerti Goto Github PK

Currently 'yarn start' spins up a React / Apollo UI which queries some random GraphQL server for currency exchange rates.

What should actually happen is that a user is presented with a landing page explaining the features the service offers. i.e. Alerts through SMS, Phone Call, and Email.

The first thing I should create is a very basic landing page, which will 404 on pages that aren't real. This way I can pre-write paths and in older builds, they will show up as 404 but once those paths have been added into the routing they'll just begin working.

This URI should require some kind of authentication, token, or otherwise to validate that the user has an account. And is largely a proof of concept to shortcut me to MVP.

For sake of simplicity ?email={}&header={}&body={} just to have emails being sent. This will be deprecated quickly with the introduction of alert publishing interfaces. And then Email will be an Alert Output.

Since the actual plan is to support SMS and phone call alerts, that will ultimately involve Twilio integration. And a more standard i.e. the Alert Output mechanism for transmitting alerts out to a variety of services.

Would be nice to hook up to some CI build service (i.e.Travis, CircleCI), some services which might track things like code coverage (i.e. coveralls, codecov) or vulnerable dependencies (i.e. snyk).

This is both because these things can be very handy for tracking various aspects of the project and also it will enable me to put a bunch of badges into the readme and everyone knows readme badges are cool.

One of the routes/links from the landing page should direct the user to a login/signup page, or they should be able to do that directly from the landing page.

Either way, being able to authenticate is going to be intrinsic to having settings and functionality specific to user accounts. Ideally, this will just be dead simple and request user email address and password. It's also possible to do this with something like a cell number the user might want to alert to but I think that's better configured inside the application after they are authenticated, and I think it's a safe assumption that all the users have email addresses.

currently, the readme is the default that comes out of create-react-app, which I think is okay momentarily while I get acquainted with everything create-react-app does. But ultimately it should reflect details about the project.