Stockphony
This is the frontend repo of the project. Please find backend backend repo : "will be aded once it is created"
Stockphony is a dynamic and user-centric web application, focusing on fostering meaningful discussions and interactions. Inspired by the concise nature of Stockphony app.
Will be added soon
- Community Engagement
Will be added soon
- Knowledge Sharing
Will be added soon
Will be added soon
Will be added soon
Will be added soon
Will be added soon
- Clone the Repository
git clone
cd
- Install Dependencies
npm install
- Run the Application
npm start
- Access the Application
Open your browser and navigate to http://localhost:3000 to view the Stockphony.
That's it! You've successfully installed and launched the Stockphony front-end application. Dive into the world of dynamic discussions and collaborative interactions.
Before deploying, you first need to make sure the homepage key in your
package.json is pointing to the correct value. It should be the url of your
deployed application.
To deploy you should first make sure you are on the master branch with a
clean working directory, then you can run npm run deploy and wait to see if
it runs successfully.
The Stockphony front-end application is designed to offer a seamless and engaging experience for users. Here's how you can make the most of its features:
- Navigate through Stockphony
Will be added soon
- React
Leveraging the power of React, the application achieves a responsive and dynamic user interface. React's component-based architecture facilitates modular development and seamless updates.
- Axios
Axios is used to make the HTTP client request for the below api end points.
- CSS
Cascading Style Sheets (CSS) is utilized to style and design the application, ensuring a visually appealing and cohesive presentation. Custom styling enhances the user experience and aligns with modern design principles.
- BootStrap
Bootstrap is used for responsive designed for buttons and forms and alert user messages.
- JavaScript
JavaScript is employed for adding interactivity and functionality to the application. From handling user interactions to managing asynchronous requests, JavaScript enhances the overall responsiveness of the Stockphony.
This template contains a handy component for creating routes that require a
user to be authenticated before visiting. This component lives in
src/auth/components/AuthenticatedRoute.js and is already required in App.
It's a thin wrapper around React Router's <Route /> component. The only
difference is that it expects a prop called user, and if that prop is falsy,
it will render a <Redirect /> that takes the user to /. To use
it, you must pass it the user as a prop!
It supports both the component= and render= attributes, but like <Route />
it will not forward props to the component if you use component=.
This template also already contains a component that displays user messages.
Messages are configurable via redux actions. This component can be found in
src/components/AutoAlertDismiss/AutoAlertDismiss.js. There is no need to add
this component to your app. It is already required in App. A single
component instance is used to manage all alerts application-wide.
The alert can be used by passing the alertMsg method to a rendered route. The
alertMsg method expects an object with a heading, message, and a variant property.
Use this component in conjunction with the messages.js file in the same
directory to create and manage all of your application messages in one place.
The variant property must be a Bootstrap alert variant, as this component is merely a
wrapper around the react-bootstrap Alert
component. The types it
will accept are: 'primary', 'secondary', 'success', 'danger', 'warning', 'info',
'light', and 'dark'.
To change the duration of the message, replace 5000 with a value of your
choice (in milliseconds) in this component's componentDidMount method.
this file will determine whether you're in a production or development
environment and choose an API URL accordingly. Don't forget to replace the
production URL with your deployed API's URL.
The top-level App component stores the currently authenticated
user in state, as well as data related to the flash messages. App renders the
Header component, and a list of routes, each of which render a component from
src/components. The src/api directory has a component file, auth.js, which
contains all the needed axios calls pertaining to authentication.
You can follow this pattern in your app as well. For instance, if you are making
an app that keeps track of books, you might want a src/api/books.js, which
contains its own axios call pertaining to your books resource CRUD actions.
Using a separate directory within components for each individual component you
add makes it easy to locate and update components and has the added benefit of
making it easy to create custom styles that apply to that specific component.
To apply component specific styles, add a file to the component's directory such
as ComponentName.scss and then import it directly into the component with
import './ComponentName.scss'. This will keep your styles modularized and
make it easier to make changes at the component level.
- Secure Account Creation and Authentication
Users can securely create accounts using a unique username, email, and password. The Stockphony employs robust authentication mechanisms to ensure the privacy and security of user information.
- Effortless Account Login and Logout
Once registered, users can seamlessly log in to their accounts, providing a personalized and secure experience. The logout feature ensures a secure session termination, prioritizing user privacy.
- Creation and Interaction
Will be added soon
- Personalized Management
Will be added soon
- Exploration and Interaction
Will be added soon
- Secure Sign-Out Functionality
Users can securely sign out of their accounts to ensure the protection of their personal information. The sign-out feature guarantees a complete and secure session closure.
These features collectively provide users with a comprehensive and secure experience within the Stockphony. From account creation to active participation in discussions, the platform prioritizes user privacy, engagement, and seamless interaction.
- Account Management
Users will have the capability to manage their accounts, allowing them to modify email addresses and update passwords. This feature enhances user control and customization within the Stockphony.
- Contributions Count and Stockphony History
Will be added soon
- User Levels and Rewards
Introducing a tiered user level system, including levels such as Blue, Gold, Silver, Platinum, and Diamond, based on user contributions. Each level will come with unique advantages, fostering a sense of achievement and recognition within the community.
- Advantages for Each Level
Will be added soon
- Enhanced User Control
Will be added soon
- Upcoming Features: CSS Enhancements
Custom Styling Options:
- Explore upcoming features that offer users the ability to apply custom styling to their Stockphony and comments. Tailor the appearance of your contributions to express your unique style within the Stockpony.
Theme Customization:
Will be added soon
Responsive Design Improvements:
Will be added soon
User Profile Customization:
Will be added soon
Login account View screenshot
Will be added soon
Will be added soon
Fork the Repository:
Fork the stockphony repository to your GitHub account.
Clone the Repository:
Clone the forked repository to your local machine using the following command:
git clone https://github.com/nugrezo/stockphony
Create a Branch:
Create a new branch for your contributions:
git checkout -b feature/your-feature-name
Make Changes:
Implement your desired changes, enhancements, or fixes within your branch.
Commit Changes:
Commit your changes with clear and concise commit messages:
git commit -m "Brief description of your changes"
Push Changes:
git push origin feature/your-feature-name
Submit a Pull Request:
Create a pull request from your branch to the main repository's develop branch. Be sure to provide a detailed description of your changes.
Code Review:
Expect feedback and engage in discussions related to your pull request. Make any necessary adjustments based on the feedback received.
Merge Pull Request:
Once your pull request is approved, it will be merged into the main repository.
Thank you for your contributions! Your efforts contribute to the growth and improvement of the Stockphony project.
The Stockphony project is licensed under the Stockphony_team. This license grants users the freedom to use, modify, and distribute the software within the terms specified in the license document.
I would like to express my gratitude to individuals and organizations that have contributed directly or indirectly to the development and success of the Stockphony project. Their support and inspiration have played a crucial role in shaping the project into what it is today.
Special thanks to:
will be added soon