Dorcas is a web-based counseling platform developed to provide students with a secure and accessible way to communicate with counselors. The system includes features such as appointment scheduling, encrypted messaging, and user authentication.
Before running the project locally, ensure the following software is installed:
- Node.js (v20 or later recommended)
- npm
- Git
git clone https://github.com/carleoj/hci-dorcas.git
cd hci-dorcasInstall the project dependencies.
npm installIf the project contains separate frontend and backend directories, install the dependencies inside each directory as well.
Example:
cd client
npm install
cd ../server
npm installCreate the required environment variable files before starting the application.
Example:
.env
Add the environment variables required by your local development environment.
Note: This repository does not include sensitive credentials. Never commit API keys, database credentials, secrets, or tokens to version control.
npm run devor
npm startOpen another terminal and run:
npm run devThe frontend development server will display a local URL (typically http://localhost:5173 when using Vite).
npm run buildTo preview the production build:
npm run previewDelete the existing dependencies and reinstall.
rm -rf node_modules
rm package-lock.json
npm installOn Windows:
rmdir /s node_modules
del package-lock.json
npm installEnsure no other application is using the configured development ports before starting the project.
- Verify the
.envfile exists. - Restart the development server after making changes.
- Confirm all required variables are defined.
- This project is intended for local development and educational purposes.
- Sensitive configuration values should be stored only in local environment files and must not be committed to the repository.
- If contributing to the project, follow standard Git practices by creating feature branches and submitting pull requests.