Merge pull request #110 from hoangsonww/homepage-enhancements

Homepage Enhancements & Updated Project Documentation
hoangsonww · Mar 19, 2024 · c610631 · c610631
2 parents a75020f + 8616ebb
commit c610631
Show file tree

Hide file tree

Showing 5 changed files with 97 additions and 2 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -53,7 +53,7 @@ There is also a mobile version of The MovieVerse, which is developed using Apach
 **Enhanced User Experience:**
 - **Responsive Design**: Enjoy a seamless experience on various devices and screen sizes.
 - **Movie Recommendations**: Receive suggestions based on your movie preferences and reviews with AI-powered recommendations.
-- **Statistics and Insights**: Access dynamically updating statistics for a tailored experience on both desktop and mobile.
+- **Statistics and Insights**: Access dynamically updating, ML-powered statistics for a tailored experience on both desktop and mobile.
 - **Community Engagement**: Connect with other users, create your profile, share your thoughts, rate movies, and engage in discussions about your favorite movies.
 
 **Additional Information:**
@@ -83,7 +83,7 @@ There are also additional directories and files for project configuration, testi
 | [JavaScript (Vanilla JS)](http://vanilla-js.com/)               | [Flask](https://flask.palletsprojects.com/en/1.1.x/)            |                                                 | [Java (for Android)](https://www.java.com/en/)                    | [WebAssembly](https://webassembly.org/)                         |
 | [TypeScript](https://www.typescriptlang.org/)                   | [Python](https://www.python.org/)                               |                                                 |                                                                   | [Google Analytics](https://analytics.google.com/analytics/web/) |
 | [FontAwesome Icons](https://react-icons.github.io/react-icons/) | [Ruby on Rails](https://rubyonrails.org/)                       |                                                 |                                                                   | [ESLint](https://eslint.org/)                                   |
-| [SASS](https://sass-lang.com/)                                  | [C (Emscripten, WebAssembly)](https://emscripten.org/)          |                                                 |                                                                   | [Git](https://git-scm.com/)                                     |
+| [SASS](https://sass-lang.com/)                                  | [C (Emscripten, WebAssembly)](https://emscripten.org/)          |                                                 |                                                                   | [TensorFlow](https://www.tensorflow.org/)                       |
 | [Single Spa](https://single-spa.js.org/)                        | [JavaScript](https://www.javascript.com/)                       |                                                 |                                                                   | [The Movie Database](https://www.themoviedb.org/)               |
 
 

diff --git a/project-config/.netlify/LICENSE b/project-config/.netlify/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Son Nguyen Hoang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/project-config/.netlify/README.md b/project-config/.netlify/README.md
@@ -0,0 +1,49 @@
+# The MovieVerse - `.netlify` Directory
+
+This directory contains configuration files used by Netlify to deploy and manage The MovieVerse website. Below are the details of each file present in the `.netlify` directory. This serves as a **sample** for deploying your own instance of MovieVerse on Netlify.
+
+## Files
+
+### `_redirects`
+
+This file contains rules for redirecting requests on your site. It's a simple text file where each line represents a redirect rule. These rules allow you to redirect traffic from one URL to another, implement URL rewrites, or set up custom 404 pages.
+
+#### Format
+
+Each line in the `_redirects` file should follow this format:
+
+```
+/path/to/source /path/to/destination [status_code]
+```
+
+- `/path/to/source`: The path that you want to redirect from.
+- `/path/to/destination`: The path where the traffic should be redirected to.
+- `[status_code]`: (Optional) The HTTP status code for the redirect, such as `301` for permanent redirects or `302` for temporary redirects.
+
+### `netlify.toml`
+
+This file is used to configure your Netlify build and deploy settings in a structured format. The `netlify.toml` file allows you to specify various settings such as build commands, publish directory, environment variables, headers, redirects, and much more.
+
+#### Structure
+
+The `netlify.toml` file is organized into sections, represented by headers in square brackets (e.g., `[build]`, `[context.production]`). Each section contains key-value pairs that specify the configuration for that aspect of your Netlify deployment.
+
+Example:
+
+```toml
+[build]
+  command = "npm run build"
+  publish = "dist"
+
+[context.production]
+  environment = { NODE_ENV = "production" }
+```
+
+- `[build]`: Defines the build settings such as the build command and the directory to publish.
+- `[context.production]`: Specifies settings that apply only to the production environment, like environment variables.
+
+## Summary
+
+The `.netlify` directory plays a crucial role in customizing how this (The MovieVerse) site is built and served on Netlify. The `_redirects` file provides powerful redirect capabilities, while the `netlify.toml` file offers comprehensive configuration options for building and deploying your site. Ensure that these files are correctly configured to take full advantage of Netlify's features for your project.
+
+--- 
diff --git a/project-config/LICENSE b/project-config/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Son Nguyen Hoang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/project-config/README.md b/project-config/README.md
@@ -57,6 +57,10 @@ Configuration file for Nginx, a web server used to handle HTTP requests, redirec
 
 Configuration file for Webpack, a static module bundler for modern JavaScript applications. This file specifies how modules within the application are treated, including rules, plugins, entry and exit points, and more.
 
+### .netlify Directory
+
+This directory contains configuration files used by Netlify to deploy and manage The MovieVerse website. Below are the details of each file present in the `.netlify` directory. This serves as a **sample** for deploying your own instance of MovieVerse on Netlify. Refer to the [`.netlify` README](./.netlify/README.md) for more details.
+
 ## Using these Files
 
 To effectively use these configuration files, it is essential to have a basic understanding of their respective tools (Babel, ESLint, Docker, Nginx, etc.). Ensure that any sensitive information is not directly included in these files, especially in public repositories.