https://github.com/caltechmsc/site
The Caltech Materials and Process Simulation Center (MSC) website.
https://github.com/caltechmsc/site
caltech nodejs site tailwindcss website
Last synced: 2 months ago
JSON representation
The Caltech Materials and Process Simulation Center (MSC) website.
- Host: GitHub
- URL: https://github.com/caltechmsc/site
- Owner: caltechmsc
- Created: 2025-01-25T00:53:19.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-20T18:00:21.000Z (3 months ago)
- Last Synced: 2025-02-20T18:27:58.463Z (3 months ago)
- Topics: caltech, nodejs, site, tailwindcss, website
- Language: EJS
- Homepage: http://www.wag.caltech.edu
- Size: 24.9 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Materials and Process Simulation Center (MSC) Website
Welcome to the official repository for the Caltech Materials and Process Simulation Center (MSC) website! This platform serves as a comprehensive hub for showcasing the groundbreaking research, publications, and events of MSC, while providing a streamlined experience for both administrators and users.
> This project is structured as a **full-stack application** with separate **frontend** and **backend** components.
## 🌐 Overview
The MSC website is designed to offer:
- A public-facing portal to **explore research, publications, and member details**.
- A secure admin dashboard for **efficient content management**.
- Auto-crawling of **publications** from external sources. (Caltech Library)
- A **responsive design** for seamless user experience across devices.
- **SEO optimization** for improved visibility on search engines.
## 📋 Features
### Public Website
- **About MSC**: Insights into the center, team biographies, and achievements.
- **Research**: Detailed information on research areas and projects.
- **Publications**: Access the latest papers, archives and most cited works.
- **Members**: Browse through the MSC team and their respective profiles.
- **Collaborators**: Information on external collaborators and their affiliations, and an interactive world map with pins representing all collaborators along with detailed information.
- **Events**: View group photos, upcoming events, and a dynamic calendar.
### Admin Dashboard
- **Administrator Management**: Manage the list of administrators.
- **Member/Collaborator Management**: Add, edit, or remove members and collaborators.
- **Content Management**: Update research overviews, member bios, and more with Quill.js.
- **Publication Crawling**: Fetch and display publications from the Caltech Library, monitor crawling status, and initiate re-crawling.
- **Event Management**: Upload and manage group photos.
- **Google OAuth Support**: Support for Google OAuth 2.0 authentication for admin login.
## 🛠️ Technologies
- **Frontend**: Node.js, Express.js, HTML (EJS), CSS (Tailwind CSS), JavaScript, Quill.js
- **Backend**: Node.js, Express.js, SQLite, Cheerio.js
## 🚀 Getting Started
### Prerequisites
- **Node.js**: Install the latest version of Node.js from the [official website](https://nodejs.org/).
- **Nginx**: Install Nginx to serve the frontend and backend on a single domain. (for reverse proxy) (Optional)
### Installation
1. **Clone the repository**:
```bash
git clone https://github.com/caltechmsc/site.git && cd site
```
2. **Setup the backend**:
1. Create a `.env` file in the `backend` directory and add the following environment variables:
```env
PORT=5000 # Port number for the server (default: 5000)
HOST=localhost # Host address for the server (default: localhost)
JWT_SECRET=secret # Secret key for JWT token generation
PUBLICATIONS_URL=https://feeds.library.caltech.edu/people/Goddard-W-A-III/article.json # URL for the Caltech Library publications
PUBLICATIONS_HTML_URL=https://caltech-msc.github.io/publications/pubs-current.html # URL for the Caltech Library publications HTML (GitHub Pages)
```
2. Install the dependencies:
```bash
cd backend # Move to the backend directory
npm install # Install the dependencies
```
3. Start the backend server:
```bash
npm start # Start the backend server
```
4. Go back to the root directory:
```bash
cd .. # Move to the root directory
```
3. **Setup the frontend**:
1. Create a `.env` file in the `frontend` directory and add the following environment variables:
```env
PORT=3000 # Port number for the server (default: 3000)
HOST=localhost # Host address for the server (default: localhost)
GOOGLE_CLIENT_ID=client_id # Google OAuth 2.0 client ID
```
> **Note:** The `GOOGLE_CLIENT_ID` is required for the admin dashboard for google login. You can generate the client ID from the [Google Cloud Console](https://console.cloud.google.com/).
2. Install the dependencies:
```bash
cd frontend # Move to the frontend directory
npm install # Install the dependencies
```
3. Build the Tailwind CSS:
```bash
npm run build:css # Build the Tailwind CSS
```
4. Start the frontend server:
```bash
npm start # Start the frontend server
```
> **Note:** The configuration to connect to the backend server is already set in the frontend application. If you want to change the backend server address, configure the server URL in the `frontend/public/js/app.js` file (Default: `/api`).
4. **Setup Nginx (Optional)**:
1. Configure Nginx as a reverse proxy `/api` to the backend server. (Default: `http://localhost:5000`)
2. Configure Nginx to serve the frontend application. (Default: `http://localhost:3000`)
3. Restart Nginx to apply the changes.
5. **Access the application**:
Open the browser and navigate to the server address to `http://localhost` to access the MSC website. (Use the configured Nginx server address if applicable)
> **Note:** If you are developing the application, you need to install the development dependencies in the root directory to use linting and formatting tools.
## 📂 Documentation
- **[Installation Guide](docs/INSTALLATION.md)**: Step-by-step guide to set up the project.
- **[Backend API Documentation](docs/API.md)**: Detailed documentation for the backend API endpoints.
## 📝 Licens
This project is not licensed under any open-source license currently. All rights are reserved by the Caltech Materials and Process Simulation Center (MSC).