LangCorrect / react-client-mui

A WIP React Client for LangCorrect

LangCorrect Client

A WIP client

About The Project

Built With

• React
• Material UI

(back to top)

Getting Started

Installation

1. Clone the repository

git clone [e-mail]:LangCorrect/react-client-mui.git

2. Install the NPM packages

npm install

3. In the root directory create a file called .env.local and add the following:

VITE_API_BASE_URL=<STAGING URL>

To ensure secure access and maintain system integrity, contributors must have their static IP addresses whitelisted before accessing the staging environment where the API is hosted. This process also prevents unnecessary indexing of the site by robots. To whitelist your static IP, please follow these steps:

1. Compose an Email:

• Send an email to support[at]langcorrect.com.
• Include the following details in your email:
  • Your GitHub username.
  • Your static IP address.

2. Request Processing Time:

• Please allow some time for your request to be processed.
• Most requests are typically processed within 24 hours.

Once your static IP is successfully whitelisted, you will be able to access the staging environment without any issues. If you encounter any difficulties or have any questions, feel free to reach out to the support team.

4. Run

npm run dev // run the server
npm run test // run the tests

(back to top)

Documentation

API Docs

You will receive a link to API documentation when you get your IP whitelisted.

(back to top)

Contributing

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)

Contact

Daniel Zeljko - LinkedIn

Project Link: https://github.com/LangCorrect/react-client-mui

Main Website: https://langcorrect.com

(back to top)