n-e-t-a-n / timetopia

An intuitive drag and drop schedule sharing website created with MERN and Apollo GraphQL

TimeTopia

An intuitive drag and drop schedule sharing website created with the MERN Stack

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

If you'd like to test out this application and get a local copy up and running, please follow these simple example steps.

Prerequisites

For this project, you will need to have the both node and the node package manager installed on your system.

You may confirm this by typing the following commands in a terminal:

node -v

v18.12.1

npm -v

9.2.0

Installation

1. Clone the repo to your local system

   git clone https://github.com/n-e-t-a-n/TimeTopia.git

2. Set NPM config in the client to gain access to Bryntum Calendar Component

   cd TimeTopia
   cd client
   
   npm config set "@bryntum:registry=https://npm.bryntum.com/"
   npm login --auth-type=legacy --registry=https://npm.bryntum.com/
   
   Username: [YOUR_BRYNTUM_EMAIL]
   Password: [YOUR_BRYNTUM_PASSWORD]

3. Install dependencies in client and server

   cd client
   npm i
   
   cd ../server
   npm i

4. Create environment file for sensitive information

   cd server
   touch .env
   
   DB_USERNAME=[YOUR_DB_USERNAME]
   DB_PASSWORD=[YOUR_DB_PASSWORD]

5. (Optional) Add a .gitignore if you'd like to submit a pull request

   touch .gitignore

6. Open 3 terminals and run the following commands

   cd client
   npm run dev

   cd server
   npm run start-exp

   cd server
   npm run start-gql

7. Visit http://localhost:5173

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact Us

Nathan Arriesgado - [email protected] / [email protected]

Bianca Uytengsu - [email protected] / [email protected]

Project Link: https://github.com/n-e-t-a-n/TimeTopia

(back to top)