About The Project
Built With
- React
- Material UI
Getting Started
Installation
- Clone the repository
git clone git@github.com:LangCorrect/react-client-mui.git
- Install the NPM packages
npm install
- 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:
- 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.
- 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.
- Run
npm run dev // run the server
npm run test // run the tests
Documentation
API Docs
You will receive a link to API documentation when you get your IP whitelisted.
Contributing
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Contact
Daniel Zeljko - LinkedIn
Project Link: https://github.com/LangCorrect/react-client-mui
Main Website: https://langcorrect.com