RxRoster

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Downloading Both Repositories
   • Installing the Backend
   • Installing the Frontend
   • Starting Up the Servers
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgments

Rx-Roster Front-End

This project allows users to access their medication history, current medications list, and add new medications. Users have to register with the website first and login each time to access their medications.

This project was bootstrapped with Create React App.

About the Project

RxRoster allows users to access their medication history, current medications list, and add new medications. Users have to register with the website first and login each time to access their medications.

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

Please follow the following instructions to get started with RxRoster.

Prerequisites

Every library or framework utilized for this project can be found in the package.json file.

To install the dependencies, please run this command:

• npm

  npm install npm@latest -g

Installation

Downloading Both Repositories

As the frontend and backend of RxRoster are in different directories, both repositories will need to be cloned to your local computer.

The repositories can be found here:

1. rx-roster-front-end (this repo)
2. rx-roster-back-end

Installing the backend

It is highly recommended that you install the backend first. Once the backend is set up, the frontend will connect to the backend via an environmental variable.

1. Obtain IAM access and JWT_SECRET keys from me by contacting me at my LinkedIn. I will create an IAM account for you and provide the AWS_SECRET_KEY_ID and ACCESS_ACCESS_KEY_ID.
2. Fork the repositiory.
3. Clone the repository.

   git clone https://github.com/rose-codes_/rx-roster-front-end.git

4. Install NPM packages.

   npm install

5. Add /node_modules to the .gitignore file if it is not already listed.
6. Create an .env file and add the AWS IAM access information:

   AWS_SECRET_KEY_ID=[Your Secret Key]
   AWS_ACCESS_KEY_ID=[Your Access Key]
   AWS_DEFAULT_REGION=us-west-1
   

7. To set up the Express server, add the following to the .env file:

    PORT=5000 [or your choice]
    NODE_ENV=development
    JWT_SECRET=[JWT_SECRET token I provide]
   

8. Add the .env file to the .gitignore.

Installing the frontend

1. Fork the repositiory.
2. Clone the repository.

   git clone https://github.com/rose-codes_/rx-roster-front-end.git

3. Install NPM packages.

   npm install

4. Add /node_modules to the .gitignore file if it is not already listed.
5. Create a .env file and add this to it:

   REACT_APP_BACKEND_URL=https://localhost:[port number you set in backend repo]
   

6. Add the .env file to the .gitignore.

Starting Up the Servers

To launch the full-stack application, you will have to start both the React server in the frontend repo and the Node/Express server in the backend repo.

Start the servers by running the respective commands:

• Frontend:

  npm run start

• Backend:

  npm run dev

These commands run the servers in development mode. Please check each repo's package.json file to see other commands to start the servers.

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add calendar widget to dashboard
• Add side navigation to dashboard
• Create separate page for "Add New Medication" form component
• Revamp "All Medications" page
• Add pharmacies widget

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Rose Le - @rhle - [email protected]

GitHub Link: https://github.com/rose-codes/rx-roster-front-end

Project Link: https://rx-roster-front-end.heroku.com

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Axios
• Daisy UI
• Emotion
• FullCalendar
• Img Shields
• React Bootstrap
• React Hook Form
• React Icons
• React Router

(back to top)