CharlZKP / R.O.S.W.E.L

Remote Ordering System Without Excessive Labor [Senior Project Version]

R.O.S.W.E.L

R.O.S.W.E.L stands for Remote Ordering System Without Excessive Labor It is a platform for ordering goods our current main target customer are customers around Chaing Mai University (CMU) where the deliverer could only be students in CMU.

Try our site »



Report Bug · Request Feature

Table of Contents

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

About The Project

R.O.S.W.E.L stands for Remote Ordering System Without Excessive Labor It is a platform for ordering goods our current main target customer are customers around Chaing Mai University (CMU) where the deliverer could only be students in CMU, after passing a KYC proccess and approved by the Admin

(back to top)

Built With

• Express
• Mongoose
• Redis
• MongoDB
• Socket.IO
• Svelte
• Tailwind CSS
• Routify

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Install Node.JS

Installation

1. Get all API Keys including thSMS and SendGrid

2. Get CMU OAuth Hubhoo configs (To enable CMU OAuth)

3. Clone the repo

   git clone https://github.com/CharlZKP/R.O.S.W.E.L.git

4. Install NPM packages

   npm install

5. Edit the backend configs in build/config.js Most configs are required Search the config file for "Needed" comment Example:

   ... //Other configs
   sendGrid {
    sender_email: '[e-mail]', //Needed
    apiKey: 'YOUR-SENDGRID-API-KEY' //Needed
   },

and check the CORS and Cookies config so that it matches with your setup

6. Run the backend by using the script

   npm run start

Or run directly using ```sh node build/index.js

7. Open the  `client` directory and install dependancies 
(Usually the Frontend and the Backend are separatable 
but in this version, we put it in the same repo with no Submodules
just for simplicity)
```sh
npm install

8. Change the variable in client\src\services\Api.ts to be the endpoint of your Backend server

   export const server_base_url = "http://localhost:2000";

   Be sure to check the Backend CORS and cookies config so that it matches with your Frontend URL

9. and run the dev server using

   npm run dev

(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". Do not forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/NewFeature)
3. Commit your Changes (git commit -m 'Add some NewFeature')
4. Push to the Branch (git push origin feature/NewFeature)
5. Open a Pull Request

(back to top)

License

The Front-end is opensource under 3-Clause BSD License Currently, the Back-end, the logo, and some image (Like the one shown on this page) are "All rights reserved". This project uses multiple libraries and templates and those will be under their own license.

(back to top)

Contact

Warach Duangjit Rawit Pichitpatja

(back to top)

Acknowledgments

Thank you all contributors for all the support you gave us. Thanks ThisGameZ for helping with the admin page

(back to top)