Le Sentier des Rêves

Réveillez le rêveur en vous.

Le Sentier des Rêves - frontend app

This project is the frontend of a dream journaling and tutorial platform called "Le Sentier des Rêves". It is built using React and is designed to provide a user-friendly interface for interacting with the backend services.

Table of Contents

• Installation
• Running the Application
• Project Structure
• Available Scripts
• Environment Variables
• Technologies Used
• Contributing
• License

Installation

To install the dependencies, you can use npm or yarn.

npm install
# or
yarn install

Running the Application

To start the application in development mode, run:

npm start
# or
yarn start

The application will be available at http://localhost:3000.

Project Structure

• public/: Contains the static assets, such as index.html and images.
• src/: Contains the source code for the React application.
  • components/: Reusable components used across the application.
  • pages/: The main pages/routes of the application.
  • context/: Context providers for global state management.
  • assets/: Images, icons, and other static resources.
  • styles/: Global and component-specific styles.
  • utils/: Utility functions and helpers.
  • App.tsx: The main component that sets up the routes.
  • index.tsx: The entry point for the React application.

Available Scripts

In the project directory, you can run:

• npm start: Runs the app in development mode.
• npm build: Builds the app for production.
• npm test: Launches the test runner.
• npm eject: Ejects the app configuration.

Environment Variables

The following environment variables are used in the project:

• REACT_APP_API_URL: The base URL for the backend API.
• REACT_APP_TINYMCE_API_KEY: The API key for TinyMCE editor.

You can create a .env file in the root of the project to define these variables.

Technologies Used

• React: A JavaScript library for building user interfaces.
• TypeScript: A superset of JavaScript that adds static typing.
• React Router: A library for managing navigation in React applications.
• Styled Components: A library for styling React components using tagged template literals.
• TinyMCE: A WYSIWYG editor for rich text editing.
• React Toastify: A library for displaying notifications and alerts.

Contributing

If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes and commit them.
4. Push your branch to your fork.
5. Open a pull request to the main repository.

Acknowledgments

• Developed by Сорок два. All rights reserved.
• Developed with love through

License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International - see the LICENSE file for details.

Contributors

Contact

For any inquiries or feedback, please visit our GitHub Repository or contact the developers directly.