Skip to content

README.md

Latest commit

 

History

History
37 lines (24 loc) · 1.4 KB

README.md

File metadata and controls

37 lines (24 loc) · 1.4 KB
Raw

UniVerse

This repository contains the codebase for the Location Preservation project, an initiative aimed at preserving and celebrating cultural heritage through digital storytelling. The project consists of two main components: the backend (api) and the frontend (client).

Project Structure

  • backend-api: This folder contains the backend codebase, including the API endpoints, data storage, and business logic.
  • frontend-client: This folder contains the frontend codebase, including the user interface and interactions.

Getting Started

To run the frontend client:

  1. Navigate to the client folder: cd client
  2. Install dependencies: npm install
  3. Start the development server: npm run dev

To run the backend API:

  1. Install dependencies: npm install
  2. Start the development server: npm run dev

Technologies Used

  • Backend: Node.js, Express.js, MongoDB
  • Frontend: React, Redux, HTML, CSS
  • Additional Tools: npm, Git

Contributing

We welcome contributions from the community to improve and expand the Location Preservation project. To contribute, please follow these steps:

  1. Fork the repository
  2. Create a new branch for your feature or bug fix: git checkout -b feature-name
  3. Make your changes and commit them: git commit -m 'Add new feature'
  4. Push to your forked repository: git push origin feature-name
  5. Submit a pull request detailing your changes